Struct FileStorePair 

pub struct FileStorePair { /* private fields */ }

The MLS store and the protocol-state store of one account, opened together.

Use this rather than opening the two stores one by one: it refuses the pairs the engine would lose data over, which the stores cannot see alone. Hand Self::secure_storage and Self::state_storage to initialize_mls, and keep the pair to close it.

Implementations

impl FileStorePair

pub fn open( mls_root: impl AsRef<Path>, state_root: impl AsRef<Path>, namespace: &str, provider: &dyn StoreKeyProvider, ) -> Result<Self, FileStoreError>

Opens the MLS store at mls_root and the protocol-state store at state_root, for the account namespace, refusing a pair the engine would lose data over.

Each refusal says what to change, and none changes or deletes a record:

• FileStoreError::RootsOverlap: one directory for both, or one inside the other. Asked as spelled before anything is created, and again of the directories once both exist, because a volume that folds case makes one directory of two spellings.
• FileStoreError::StateWithoutIdentity: protocol state with no MLS record beside it. A new identity would be minted, and it could not unseal that state. Asked before anything is created.
• FileStoreError::ForeignState: protocol state that belongs to another MLS store. Asked once both are open.
• Whatever either store’s own open refuses: a wrong key, a directory another store holds.

A record key the MLS store reports as damaged is not refused: nothing opens the state sealed under it again, and the engine’s new key and its settlement of that state as failed is how the application learns which messages were lost. Once the pair is bound (this binds it), the pairing ids decide every later open, so the records left under the lost key do not make it look like another identity’s state. A pair whose record key was regenerated while its stores were opened one by one, never bound, is still judged by those records on its first open here, and can be refused.

A pair that passes is bound: both stores hold the same pairing id from then on.

pub fn secure_storage(&self) -> Arc<SealedFileMlsStorage>

The MLS store, for initialize_mls.

pub fn state_storage(&self) -> Arc<FileProtocolStateStorage>

The protocol-state store, for initialize_mls.

pub fn close(&self)

Releases both directories, whoever still holds either store. The protocol-state store first: it is the one sealed under the other’s record key. See SealedFileMlsStorage::close.

Trait Implementations

impl Clone for FileStorePair

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileStorePair

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

Formats the value using the given formatter.