Struct InviteCode

pub struct InviteCode(Vec<InviteCodePart>);

Information required for client to join Federation

Can be used to download the configs and bootstrap a client.

Invariants

Constructors have to guarantee that:

• At least one Api entry is present
• At least one Federation ID is present

Tuple Fields

0: Vec<InviteCodePart>

Implementations

impl InviteCode

pub fn new( url: SafeUrl, peer: PeerId, federation_id: FederationId, api_secret: Option<String>, ) -> Self

pub fn from_map( peer_to_url_map: &BTreeMap<PeerId, SafeUrl>, federation_id: FederationId, api_secret: Option<String>, ) -> Self

pub fn new_with_essential_num_guardians( peer_to_url_map: &BTreeMap<PeerId, SafeUrl>, federation_id: FederationId, ) -> Self

Constructs an InviteCode which contains as many guardian URLs as needed to always be able to join a working federation

pub fn url(&self) -> SafeUrl

Returns the API URL of one of the guardians.

pub fn api_secret(&self) -> Option<String>

Api secret, if needed, to use when communicating with the federation

pub fn peer(&self) -> PeerId

Returns the id of the guardian from which we got the API URL, see InviteCode::url.

pub fn peers(&self) -> BTreeMap<PeerId, SafeUrl>

Get all peer URLs in the InviteCode

pub fn federation_id(&self) -> FederationId

Returns the federation’s ID that can be used to authenticate the config downloaded from the API.

Trait Implementations

impl Clone for InviteCode

fn clone(&self) -> InviteCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InviteCode

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

Formats the value using the given formatter.

impl Decodable for InviteCode

fn consensus_decode<R: Read>( r: &mut R, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object with a well-defined format.

fn consensus_decode_from_finite_reader<R: Read>( r: &mut R, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode_whole( slice: &[u8], modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

fn consensus_decode_hex( hex: &str, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

impl<'de> Deserialize<'de> for InviteCode

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InviteCode

Parses the invite code from a bech32 string

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

Formats the value using the given formatter.

impl Encodable for InviteCode

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

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

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, H::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

fn consensus_hash_sha256(&self) -> Hash

Self::consensus_hash for [bitcoin::hashes::sha256::Hash]

impl FromStr for InviteCode

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for InviteCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for InviteCode

fn cmp(&self, other: &InviteCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for InviteCode

fn eq(&self, other: &InviteCode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for InviteCode

fn partial_cmp(&self, other: &InviteCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for InviteCode

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for InviteCode

impl StructuralPartialEq for InviteCode