Struct fedimint_core::api::InviteCode

pub struct InviteCode(/* private fields */);

Information required for client to construct WsFederationApi instance

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

Implementations

impl InviteCode

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

pub fn url(&self) -> SafeUrl

Returns the API URL of one of the guardians.

pub fn peer(&self) -> PeerId

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

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_hex( hex: &str, modules: &ModuleDecoderRegistry ) -> Result<Self, DecodeError>

Decode an object from hex

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) -> Result<Vec<u8>, Error>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> Result<String, Error>

fn consensus_hash<H>(&self) -> Hwhere H: Hash, H::Engine: Write,

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

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 PartialEq for InviteCode

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

This method tests for self and other values to be equal, and is used by ==.

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

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

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 StructuralEq for InviteCode

impl StructuralPartialEq for InviteCode