Skip to main content

SessionState

Struct SessionState 

Source
pub struct SessionState {
    pub root_key: String,
    pub their_current_nostr_public_key: Option<String>,
    pub their_next_nostr_public_key: Option<String>,
    pub our_previous_nostr_key: Option<KeyPairBytes>,
    pub our_current_nostr_key: Option<KeyPairBytes>,
    pub our_next_nostr_key: KeyPairBytes,
    pub receiving_chain_key: Option<String>,
    pub sending_chain_key: Option<String>,
    pub sending_chain_message_number: u32,
    pub receiving_chain_message_number: u32,
    pub previous_sending_chain_message_count: u32,
    pub skipped_keys: BTreeMap<String, SkippedKeysEntry>,
}
Expand description

The full double-ratchet session state for one 1:1 channel.

Held in memory and cloned for the plan/apply transaction model. JSON persistence is a separate concern layered on later; the wire-critical Header is the only type with a fixed external encoding.

Fields§

§root_key: String

Root chain key (hex).

§their_current_nostr_public_key: Option<String>

Peer’s current DH public key (x-only hex), if known.

§their_next_nostr_public_key: Option<String>

Peer’s next DH public key (x-only hex), if known.

§our_previous_nostr_key: Option<KeyPairBytes>

Our previous DH keypair (kept to decrypt late-arriving messages).

§our_current_nostr_key: Option<KeyPairBytes>

Our current DH keypair.

§our_next_nostr_key: KeyPairBytes

Our next DH keypair (advertised in outgoing headers).

§receiving_chain_key: Option<String>

Receiving chain key (hex), if a receiving chain exists.

§sending_chain_key: Option<String>

Sending chain key (hex), if a sending chain exists.

§sending_chain_message_number: u32

Next index to use on the sending chain.

§receiving_chain_message_number: u32

Next index expected on the receiving chain.

§previous_sending_chain_message_count: u32

Number of messages sent on the previous sending chain.

§skipped_keys: BTreeMap<String, SkippedKeysEntry>

Skipped message keys, keyed by sender DH pubkey (hex).

Trait Implementations§

Source§

impl Clone for SessionState

Source§

fn clone(&self) -> SessionState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SessionState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for SessionState

Scrub the chain/root secrets on drop. our_*_nostr_key (KeyPairBytes) and skipped_keys (SkippedKeysEntry) values scrub themselves via their own Drop impls when this struct’s fields are subsequently dropped.

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Eq for SessionState

Source§

impl PartialEq for SessionState

Source§

fn eq(&self, other: &SessionState) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SessionState

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.