Skip to main content

VaultError

Enum VaultError 

Source
pub enum VaultError {
    BadRequest(String),
    PermissionDenied(String),
    NotFound {
        path: String,
    },
    Stale(String),
    Standby(String),
    Sealed(String),
    Unexpected {
        status: u16,
        message: String,
    },
    Transport(String),
    Malformed {
        path: String,
        message: String,
    },
}
Expand description

A failure from the secret store.

Variants§

§

BadRequest(String)

400 — the request itself was wrong.

§

PermissionDenied(String)

403 — no token, an expired one, or one without the policy for this path.

Vault does not distinguish “expired” from “not allowed”, so neither can this. The message says so rather than guessing.

§

NotFound

404 — no such path, or nothing stored at it.

Worth its own variant because it is usually not an error: reading a secret that may not be there yet is an ordinary thing to do.

Fields

§path: String
§

Stale(String)

412 — a standby node has not caught up with the value being asked for. Retrying against the active node is the fix, and it usually works.

§

Standby(String)

429 — a standby that will not serve this request at all.

§

Sealed(String)

503 — the store is sealed or unavailable. Nothing the caller does helps; somebody has to unseal it.

§

Unexpected

Anything else, including a body that did not parse.

Fields

§status: u16
§message: String
§

Transport(String)

The request never reached the server.

§

Malformed

The store answered successfully, with something this driver cannot read.

Distinct from every variant above, which are the store saying no. This one is the store saying yes and handing over a shape we did not expect — a KV version 1 mount read as version 2, or credentials with no password in them. Retrying cannot help, and treating it as a plain failure would hide the one detail that explains it: which path, and what was wrong.

Fields

§path: String
§message: String

Implementations§

Source§

impl VaultError

Source

pub fn from_response(status: u16, path: &str, body: &str) -> VaultError

Build from a status code and whatever body came with it.

Source

pub fn is_retryable(&self) -> bool

Whether trying again, unchanged, could plausibly work.

A sealed store is deliberately not retryable: unsealing is a human action that takes minutes at best, and hammering the endpoint until it happens only buries the log line that would have explained the outage.

Source

pub fn needs_new_token(&self) -> bool

Whether re-authenticating and trying again could work.

Source

pub fn is_not_found(&self) -> bool

Trait Implementations§

Source§

impl Clone for VaultError

Source§

fn clone(&self) -> Self

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 VaultError

Source§

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

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

impl Display for VaultError

Source§

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

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

impl Eq for VaultError

Source§

impl Error for VaultError

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 From<VaultError> for Error

Source§

fn from(error: VaultError) -> Error

Converts to this type from the input type.
Source§

impl PartialEq for VaultError

Source§

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

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