Vault

Struct Vault 

Source
pub struct Vault { /* private fields */ }
Expand description

Represents a client to interact with HashiCorp Vault using HTTP(S).

Contains configuration and an HTTP client used for making API requests to Vault.

Implementations§

Source§

impl Vault

Source

pub fn new() -> VaultBuilder

Source

pub async fn health_check(&self) -> Result<(), Box<dyn Error + Send + Sync>>

This method sends a GET request to the /v1/sys/health endpoint of the Vault server, which provides status information about the Vault node (e.g., whether it is initialized, unsealed, and active).

§Returns
  • Ok(()) if the Vault server responds with a healthy status (200 OK).
  • Err(...) with a VaultError if the response indicates an unhealthy or non-operational state, such as being sealed, a standby node, or uninitialized.
§Errors

Returns an error if:

  • The Vault URI is invalid.
  • The HTTP request fails.
  • The Vault server returns a non-200 status code that maps to a known or unknown VaultError.
§Example
let vault = Vault::new()
    .address("127.0.0.1".to_string())
    .port(8200)
    .token("my-token".to_string())
    .https()
    .build()
    .await?;

vault.health_check().await?;
§Vault Status Codes
  • 200 OK: Vault is initialized and unsealed.
  • 503: Vault is sealed.
  • 472: Vault is a standby performance secondary node.
  • 473: Vault is a standby performance node.
  • 501: Vault is not initialized.
  • 404: Invalid path (possibly misconfigured secret path).
Source

pub async fn get_secret<T>(self) -> Result<T, Box<dyn Error + Send + Sync>>

Source

pub async fn get_secret_v2<T>(self) -> Result<T, Box<dyn Error + Send + Sync>>

Auto Trait Implementations§

§

impl Freeze for Vault

§

impl !RefUnwindSafe for Vault

§

impl Send for Vault

§

impl Sync for Vault

§

impl Unpin for Vault

§

impl !UnwindSafe for Vault

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