Struct vault_rs::Client

pub struct Client { /* fields omitted */ }

Vault API Client

Methods

impl Client

pub fn new<S1, S2, S3>(
    vault_address: Option<S1>,
    vault_token: Option<S2>,
    root_ca: Option<S3>,
    revoke_self_on_drop: bool
) -> Result<Self, Error> where
    S1: AsRef<str>,
    S2: AsRef<str>,
    S3: AsRef<str>, 

Create a new Vault Client.

You can optionally provide a reqwest::Client if you have specific needs like custom root CA certificate or require client authentication

pub fn from_environment<S1, S2, S3>(
    address: Option<S1>,
    token: Option<S2>,
    ca_cert: Option<S3>
) -> Result<Self, Error> where
    S1: AsRef<str>,
    S2: AsRef<str>,
    S3: AsRef<str>, 

Create a client from environment variables. You can provide alternative sources of the parameters with the optional arguments

The vnrionment variables are:

• VAULT_ADDR: Vault Address
• VAULT_TOKEN: Vault Token
• VAULT_CACERT: Path to the CA Certificate for Vault

pub fn address(&self) -> &str

Returns the Vault address

pub async fn revoke_self<'_>(&'_ self) -> Result<(), Error>

Revoke the Vault token itself

If successful, the Vault Token can no longer be used

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Drop for Client

fn drop(&mut self)

Executes the destructor for this type.

impl Vault for Client

fn read<'life0, 'life1, 'async_trait>(
    &'life0 self,
    path: &'life1 str,
    method: Method
) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Read a generic Path from Vault

fn read_with_query<'life0, 'life1, 'life2, 'async_trait, T: Serialize + Send + Sync + ?Sized>(
    &'life0 self,
    path: &'life1 str,
    method: Method,
    query: &'life2 T
) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>> where
    T: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Read a generic Path from Vault with Query

fn write<'life0, 'life1, 'life2, 'async_trait, T: Serialize + Send + Sync>(
    &'life0 self,
    path: &'life1 str,
    payload: &'life2 T,
    method: Method,
    response_expected: bool
) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>> where
    T: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Write to a generic Path in Vault.

fn get<'life0, 'life1, 'async_trait>(
    &'life0 self,
    path: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: Sync + 'async_trait, 

Convenience method to Get a generic path from Vault

fn get_with_query<'life0, 'life1, 'life2, 'async_trait, T: Serialize + Send + Sync + ?Sized>(
    &'life0 self,
    path: &'life1 str,
    query: &'life2 T
) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>> where
    T: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: Sync + 'async_trait, 

Convenience method to Get a generic path from VaultResult

fn list<'life0, 'life1, 'async_trait>(
    &'life0 self,
    path: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: Sync + 'async_trait, 

Convenience method to List a generic path from Vault

fn post<'life0, 'life1, 'life2, 'async_trait, T: Serialize + Send + Sync>(
    &'life0 self,
    path: &'life1 str,
    payload: &'life2 T,
    response_expected: bool
) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>> where
    T: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: Sync + 'async_trait, 

Convenience method to Post to a generic path to Vault

fn put<'life0, 'life1, 'life2, 'async_trait, T: Serialize + Send + Sync>(
    &'life0 self,
    path: &'life1 str,
    payload: &'life2 T,
    response_expected: bool
) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>> where
    T: 'async_trait,
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: Sync + 'async_trait, 

Convenience method to Put to a generic path to Vault

fn delete<'life0, 'life1, 'async_trait>(
    &'life0 self,
    path: &'life1 str,
    response_expected: bool
) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: Sync + 'async_trait, 

Convenience method to Delete a Path from Vault