Enum FileStoreError 

#[non_exhaustive]
pub enum FileStoreError {
    InvalidNamespace,
    Io {
        path: PathBuf,
        source: Error,
    },
    StoreKey(StoreKeyError),
    WrongStoreKey(PathBuf),
    KeyCheckUnverifiable(PathBuf),
    InUse(PathBuf),
    Closed(PathBuf),
    RecordKeyUnreadable(String),
    RootsOverlap {
        mls_root: PathBuf,
        state_root: PathBuf,
        on_this_volume: bool,
    },
    StateWithoutIdentity {
        state: PathBuf,
        mls_root: PathBuf,
    },
    ForeignState {
        state: PathBuf,
        mls_root: PathBuf,
    },
}

Why a built-in file store could not be opened, or could not answer a question about its directory.

Opening and the probes are the only steps with their own error type: a record operation reports through the error type of the trait the store implements.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidNamespace

The namespace is not the output of account_storage_namespace.

Io

The store directory could not be created or read.

Fields

path: PathBuf

The directory the store tried to use.

source: Error

The underlying failure.

StoreKey(StoreKeyError)

The store key provider did not produce a key.

WrongStoreKey(PathBuf)

The store key does not open this store’s records.

Nothing was read, changed or deleted. The usual cause is the operator supplying a different key than the one the store was created with.

KeyCheckUnverifiable(PathBuf)

The key check file does not open, and the store holds no record that could prove the key either way.

Nothing was read, changed or deleted. Either the key is wrong or the check file is damaged, and an empty store cannot tell the two apart. With nothing sealed to lose, removing the check file named here lets the next open start the store afresh under the key offered.

InUse(PathBuf)

Another store already has this directory open, in this process or in another one.

Nothing was read or changed. Two stores over one directory would diverge the MLS state, so the second is refused rather than guarded.

Closed(PathBuf)

The store was closed, and holds its directory no longer.

RecordKeyUnreadable(String)

The MLS store could not say whether it holds the key that seals protocol state.

Nothing was changed. This is a read that failed, not a key that is missing or damaged: those are answers, and are reported as SealedState.

RootsOverlap

FileStorePair::open was given one directory for both roots, or one inside the other.

The MLS root holds the identity and must survive the removal of the state root, which is scoped to the installation. When on_this_volume is set, the roots are spelled apart and are one directory only on this volume (one that folds case), which shows only once both exist: the stores’ directories were created then, and no record was written.

Fields

mls_root: PathBuf

The MLS root as given.

state_root: PathBuf

The protocol-state root as given.

on_this_volume: bool

Found only once both directories existed.

StateWithoutIdentity

The protocol-state account directory holds records and the MLS root holds no identity for the account.

Nothing was created. Opening would mint a new identity (a new address) whose record key cannot unseal those records, and the first restore would delete the ones it read: a deployment moving onto the file stores with a kept state root, or one whose MLS root was lost.

Fields

state: PathBuf

The protocol-state account directory.

mls_root: PathBuf

The MLS root.

ForeignState

The protocol-state account directory belongs to another MLS store: it is bound to another one, or its sealed records open under no record key this one holds.

No record was changed. Handing the pair to an engine would delete the queued and parked messages its restore reads.

Fields

state: PathBuf

The protocol-state account directory.

mls_root: PathBuf

The MLS root.

Trait Implementations

impl Debug for FileStoreError

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

Formats the value using the given formatter.

impl Display for FileStoreError

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

Formats the value using the given formatter.

impl Error for FileStoreError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<StoreKeyError> for FileStoreError

fn from(source: StoreKeyError) -> Self

Converts to this type from the input type.