Struct InviteSecret 

pub struct InviteSecret(Zeroizing<[u8; 32]>);

The invite secret: 32 random, high-entropy bytes carried in the invite link.

CRITICAL: This must never be sent to the server.

Tuple Fields

0: Zeroizing<[u8; 32]>

Implementations

impl InviteSecret

fn make() -> Self

Generates a fresh invite secret: 32 random, high-entropy bytes drawn from the SDK CSPRNG.

Trait Implementations

impl Clone for InviteSecret

fn clone(&self) -> InviteSecret

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for InviteSecret

fn ct_eq(&self, other: &InviteSecret) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for InviteSecret

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InviteSecret

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&InviteSecret> for String

fn from(secret: &InviteSecret) -> Self

Converts to this type from the input type.

impl FromStr for InviteSecret

type Err = InviteKeyBundleError

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 HighEntropySecretSource for InviteSecret

Exposes the invite secret as a [HighEntropySecret]. This is sound because the invite secret is 32 bytes sampled from a CSPRNG.

fn provide_high_entropy_bytes(&self) -> SensitiveSlice<'_>

Returns the secret bytes as a redacted [SensitiveSlice].

impl PartialEq for InviteSecret

fn eq(&self, other: &Self) -> 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 Serialize for InviteSecret

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

where S: Serializer,

Serialize this value into the given Serde serializer.