Struct InviteCode 

pub struct InviteCode {
    pub store: StoreId,
    pub name: String,
    pub inviter: String,
    pub kind: InviteKind,
    pub expires_at: u64,
    pub invite: InviteId,
    pub member: MemberId,
    pub secret: InviteSecret,
    pub initial_key: KeyId,
    pub inviting_writer: DeviceId,
    pub read_through: u64,
    pub storage: SecretBytes,
}

A one-time invitation; the secret permits a join request, not store access.

Fields

store: StoreId

The store’s id.

name: String

The store’s display name.

inviter: String

The inviting admin’s name, as their app gave it when it made the invite: the joining device can’t read who is who until it is let in.

kind: InviteKind

Whether the invite adds a new person or recovers a member.

expires_at: u64

When the invite ends, in seconds since the Unix epoch by the inviting device’s clock: a joining device sends no first request after it.

invite: InviteId

The invite named by the join request.

member: MemberId

The member id the admin fixed: fresh for an addition, or an existing active id for a re-binding. The signed request must repeat it (D13).

secret: InviteSecret

Crypto owns the one-time secret and its erasure.

initial_key: KeyId

The store key introduced by the creation entry, even after rotations.

inviting_writer: DeviceId

The device whose claimed approval supplies binding evidence.

read_through: u64

The inviting device’s last applied slot.

storage: SecretBytes

Storage settings, including any credentials for the recipient.

Implementations

impl InviteCode

pub const TEXT_PREFIX: &'static str = "CVI1-"

How an invite code’s text starts: its kind and version.

pub fn request_path(&self) -> ObjectPath

Where the joining device’s request goes: under the device that made the invite, as this code names it (§13.2).

pub fn to_bytes(&self) -> Result<Zeroizing<Vec<u8>>, Error>

Encode a bounded frame into a buffer erased on drop, allocated once.

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

Decode a borrowed frame; every owned secret buffer erases on drop.

pub fn to_text(&self) -> Result<Zeroizing<String>, Error>

Canonical uppercase base32, with CRC-32C, erased on drop.

pub fn from_text(text: &str) -> Result<Self, Error>

Decode borrowed text without retaining any unerased private copies.

Trait Implementations

impl Debug for InviteCode

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

Formats the value using the given formatter.