Skip to main content

GroupStateSnapshot

Struct GroupStateSnapshot 

Source
pub struct GroupStateSnapshot {
    pub v: u8,
    pub group_id: ConversationId,
    pub openmls_storage_version: u16,
    pub snapshot_created_at_ms: u64,
    pub entries: Vec<GroupSnapshotEntry>,
}
Expand description

[CR-7] Portable snapshot of an MLS group’s OpenMLS state.

Produced by [Conversation::export_state_snapshot] on one device, consumed by [MessagingClient::import_state_snapshot] on another to re-attach to the same group without re-Welcoming. The receiver MUST be the same user identity (the linking-flow QR handshake or recovery mnemonic provides that).

What’s in: every OpenMLS storage entry whose key references this group’s group_id. Trees, contexts, transcript hashes, message secrets, epoch keys — everything MlsGroup::load needs to reconstruct the live group object.

What’s out: signature keypairs (recovered devices ALWAYS get a fresh signing key per [recovery.md §recovery on a new device]); leaf-keyed encryption keypairs for other leaves (those don’t have the group_id in their key by definition); pending KeyPackages (per-device; receiver generates fresh ones on first publish).

Forward secrecy note: this snapshot exposes the exporter’s view of past epoch secrets for this group. That’s intentional for the linking + DG-recovery use cases (same user, trusted handover via QR / mnemonic). It is NOT used for peer-conversation history transfer — that goes through HPKE-sealed AppEvent re-shares per umbrella §15.6. Hosts MUST ensure callers of export_state_snapshot are authenticated to the user’s intent.

Fields§

§v: u8

Format version. Bumped on incompatible CBOR-shape changes.

§group_id: ConversationId

Group id this snapshot describes. Sanity-checked on import — passing a snapshot for the wrong group is an error.

§openmls_storage_version: u16

OpenMLS storage-provider version at export time. Import refuses mismatched versions outright (no automatic forward/back compat).

§snapshot_created_at_ms: u64

Wall-clock ms at export. Informational; receivers can warn on stale snapshots but the SDK does not act on it.

§entries: Vec<GroupSnapshotEntry>

(raw_storage_key, raw_storage_value) pairs lifted from the exporter’s MemoryStorage. The receiver replays them into its own provider via import_entries.

Implementations§

Source§

impl GroupStateSnapshot

Source

pub fn encode(&self) -> Result<Vec<u8>>

CBOR-encode the snapshot. Hard-cap-rejects oversize blobs; logs a warning at the soft cap.

Source

pub fn decode(bytes: &[u8]) -> Result<Self>

Decode a CBOR-encoded snapshot. Rejects unknown v and oversize inputs.

Trait Implementations§

Source§

impl Clone for GroupStateSnapshot

Source§

fn clone(&self) -> GroupStateSnapshot

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 GroupStateSnapshot

Source§

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

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

impl<'de> Deserialize<'de> for GroupStateSnapshot

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for GroupStateSnapshot

Source§

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

Serialize this value into the given Serde serializer. Read more

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more