Skip to main content

SessionState

Enum SessionState 

Source
pub enum SessionState {
    Idle,
    Offered {
        pending: PendingOffer,
    },
    OfferReceived {
        bundle: PreKeyBundle,
    },
    AwaitingAck {
        ratchet: Ratchet,
    },
    Established {
        ratchet: Ratchet,
    },
    Rejected,
    Closed,
}
Expand description

How far a conversation has got towards being encrypted.

Only SessionState::Established carries a ratchet that will decrypt content, which is what makes “an accept does not mean established” a property of the type.

Deliberately not Debug: two of these variants hold key material, and a derived formatter would put it in whatever log the caller happens to write.

Variants§

§

Idle

Nothing has been offered yet.

§

Offered

We sent init and are waiting for an answer.

Fields

§pending: PendingOffer

The keys we offered, kept until the answer arrives.

§

OfferReceived

They sent init and we have not answered yet.

Fields

§bundle: PreKeyBundle

What they offered.

§

AwaitingAck

We answered and are waiting for the ack that proves they can decrypt.

An accept can be lost, so showing a lock here would tell the user something untrue. This state deliberately exposes no way to decrypt content.

Fields

§ratchet: Ratchet

The ratchet, held but not yet trusted to carry content.

§

Established

The session works in both directions.

Fields

§ratchet: Ratchet

The live ratchet.

§

Rejected

They refused.

§

Closed

The session ended.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.