Struct DocTicket

pub struct DocTicket {
    pub capability: Capability,
    pub nodes: Vec<NodeAddr>,
}

Available on crate feature net only.

Contains both a key (either secret or public) to a document, and a list of peers to join.

Fields

capability: Capability

either a public or private key

nodes: Vec<NodeAddr>

A list of nodes to contact.

Implementations

impl DocTicket

pub fn new(capability: Capability, peers: Vec<NodeAddr>) -> Self

Create a new doc ticket

Trait Implementations

impl Clone for DocTicket

fn clone(&self) -> DocTicket

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocTicket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocTicket

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DocTicket

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for DocTicket

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for DocTicket

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Ticket for DocTicket

const KIND: &'static str = "doc"

String prefix describing the kind of iroh ticket.

fn to_bytes(&self) -> Vec<u8>

Serialize to bytes used in the base32 string representation.

fn from_bytes(bytes: &[u8]) -> Result<Self, Error>

Deserialize from the base32 string representation bytes.

fn serialize(&self) -> String

Serialize to string.

fn deserialize(str: &str) -> Result<Self, Error>

Deserialize from a string.