Enum Frame 

pub enum Frame {
    Init {
        bundle: PreKeyBundle,
        account: Option<String>,
    },
    Accept {
        response: HandshakeResponse,
        account: Option<String>,
    },
    Reject {
        reason: Option<String>,
    },
    Ack {
        ct: RatchetMessage,
    },
    Close,
    Msg {
        ct: RatchetMessage,
    },
    Media {
        ct: RatchetMessage,
    },
}

One t/v protocol frame, exactly as the wire’s client-only tag carries it (init, accept, reject, ack, close) or, for msg and media, the ?obe2ee:-prefixed body.

frag is not a variant here: it wraps another frame’s encoded bytes across several wire lines and belongs to the transport that reassembles it, not to session logic. See Frag.

Variants

Init

An offer to start an encrypted session.

Fields

bundle: PreKeyBundle

The offering side’s prekey bundle.

account: Option<String>

The sender’s SASL account, when it has one.

Accept

An answer to an offer.

Fields

response: HandshakeResponse

The answering side’s handshake response.

account: Option<String>

The sender’s SASL account, when it has one.

Reject

A refusal of an offer.

Fields

reason: Option<String>

An optional human-readable reason.

Ack

The initiator’s first encrypted payload, proving the session works.

Fields

ct: RatchetMessage

The ratchet-encrypted empty payload.

Close

The end of a session.

Msg

An encrypted text message.

Fields

ct: RatchetMessage

The ratchet-encrypted payload.

Media

An encrypted file descriptor.

Fields

ct: RatchetMessage

The ratchet-encrypted payload, whose plaintext is a media descriptor.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Frame

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Frame

impl PartialEq for Frame

fn eq(&self, other: &Frame) -> 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 Frame

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Frame