Skip to main content

StoreError

Enum StoreError 

Source
pub enum StoreError {
    NotFound {
        path: String,
    },
    Unreachable {
        path: String,
        reason: String,
    },
    Denied {
        path: String,
        reason: String,
    },
    Backend {
        path: String,
        reason: String,
    },
    Layout {
        reason: String,
    },
    Conflict {
        path: String,
        reason: String,
    },
    Unsupported {
        operation: String,
        reason: String,
    },
}
Expand description

What a SecretStore can fail with.

Every variant that names a location names the rendered path, not the CredentialRef, because the path is what an operator needs in order to go and look — and because a reference renders differently under each Layout, so quoting the address alone would send them to the wrong place. Layout is the exception, and only because there is no rendered path in that case: the path was the input, and the layout’s own message quotes it. None of them carries a value: a StoreError is safe to log.

Variants§

§

NotFound

The backend answered, and there is nothing stored at that path.

Distinct from Unreachable on purpose: this one means “this tenant has not connected that integration”, and the other means “we cannot say”.

Fields

§path: String

The path the store looked at.

§

Unreachable

The backend could not be reached, or did not answer in a usable way.

A retry may succeed. Never present this to a caller as “not configured”.

Fields

§path: String

The path the store was trying to reach.

§reason: String

What went wrong on the wire.

§

Denied

The backend answered and refused: the store’s own credentials are missing, expired or not authorised for that path.

Fields

§path: String

The path access was refused to.

§reason: String

What the backend said.

§

Backend

The backend answered with something this client cannot interpret — a response shape it does not recognise, or a status it has no meaning for.

Separate from Unreachable because retrying will not help.

Fields

§path: String

The path in question.

§reason: String

Why the response could not be used.

§

Layout

The configured Layout could not recover the address from a path.

A custom layout is allowed to refuse a path it cannot spell; that is stated in Layout’s contract as the alternative to guessing. Layout::render is infallible, so Layout::parse is the only place a layout can refuse, and MemoryStore::reference and VaultStore::reference are the two calls that raise this. That pairing is deliberate: a variant no store can construct is a promise that does not hold, and this one used to be exactly that (C-149).

Fields

§reason: String

The layout’s own explanation.

§

Conflict

A checked mutation conflicts with the state already stored at its address.

Fields

§path: String

The rendered address in conflict.

§reason: String

The checked precondition that failed.

§

Unsupported

The backend cannot provide a requested guarantee.

Fields

§operation: String

The store operation that was requested.

§reason: String

Why this backend cannot honour it.

Implementations§

Source§

impl StoreError

Source

pub fn is_not_found(&self) -> bool

Whether this is NotFound — the “this tenant has not connected it” case.

A named predicate because the distinction is the reason the error type exists, and because a caller reaching for it should not have to spell out a match over a growing enum.

Trait Implementations§

Source§

impl Clone for StoreError

Source§

fn clone(&self) -> StoreError

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 StoreError

Source§

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

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

impl Display for StoreError

Source§

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

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

impl Eq for StoreError

Source§

impl Error for StoreError

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl PartialEq for StoreError

Source§

fn eq(&self, other: &StoreError) -> 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 StoreError

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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