Struct Identity 

pub struct Identity {
    pub inbox_id: String,
    pub installation_keys: XmtpInstallationCredential,
    pub credential: Credential,
    pub signature_request: Option<SignatureRequest>,
    pub is_ready: Atomic<bool>,
}

Fields

inbox_id: String

The inbox this installation belongs to.

installation_keys: XmtpInstallationCredential

The installation’s signing key pair.

credential: Credential

The MLS credential that names inbox_id.

signature_request: Option<SignatureRequest>

The signatures a new identity still needs before registration; None once the identity is registered.

is_ready: Atomic<bool>

Whether the identity is registered and usable.

Implementations

impl Identity

pub fn inbox_id(&self) -> &str

pub fn installation_id(&self) -> InstallationId

pub fn sequence_id<C>( &self, conn: &DbConnection<C>, ) -> Result<i64, ConnectionError>

where C: ConnectionExt,

pub fn is_ready(&self) -> bool

pub fn set_ready(&self)

Marks the identity as registered.

pub fn signature_request(&self) -> Option<SignatureRequest>

pub fn credential(&self) -> Credential

pub fn sign_identity_update<Text>( &self, text: Text, ) -> Result<Vec<u8>, IdentityError>

where Text: AsRef<str>,

Sign the given text with the installation private key.

pub fn sign_with_public_context( &self, text: impl AsRef<str>, ) -> Result<Vec<u8>, IdentityError>

Trait Implementations

impl Clone for Identity

fn clone(&self) -> Identity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identity

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

Formats the value using the given formatter.

impl TryFrom<StoredIdentity> for Identity

type Error = StorageError

The type returned in the event of a conversion error.

fn try_from( identity: StoredIdentity, ) -> Result<Identity, <Identity as TryFrom<StoredIdentity>>::Error>

Performs the conversion.