Client

Struct Client 

Source
pub struct Client<T>
where T: Auth,
{ /* private fields */ }
Expand description

The Client struct represents a single Vault-Connection/Session that can be used for any further requests to vault

Implementations§

Source§

impl<T> Client<T>
where T: Auth,

Source

pub fn new(conf: Config, auth_opts: T) -> Result<Client<T>, Error>

This function is used to obtain a new vault session with the given config and auth settings

Source

pub fn renew_background(&self) -> Result<(), RenewError>

This function will enter an infitive Loop and blocks the current thread. It will do everything related to renewing the token/session. This will idealy run inside it’s own thread as to not block anything else important

Source

pub fn get_token(&self) -> String

A simple method to get the underlying vault session/client token for the current vault session. It is not recommended to use this function, but rather stick to other more integrated parts, like the vault_request function

Source

pub async fn check_session(&self) -> Result<(), Error>

This function is used to check if the current session is still valid and if not to renew the session/obtain a new one and update all data related to it

Source

pub async fn vault_request<P: Serialize>( &self, method: Method, path: &str, body: Option<&P>, ) -> Result<Response, Error>

This function is a general way to directly make requests to vault using the current session. This can be used to make custom requests or to make requests to mounts that are not directly covered by this crate.

Auto Trait Implementations§

§

impl<T> !Freeze for Client<T>

§

impl<T> RefUnwindSafe for Client<T>
where T: RefUnwindSafe,

§

impl<T> Send for Client<T>
where T: Send,

§

impl<T> Sync for Client<T>
where T: Sync,

§

impl<T> Unpin for Client<T>
where T: Unpin,

§

impl<T> UnwindSafe for Client<T>
where T: UnwindSafe,

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

impl<T> ErasedDestructor for T
where T: 'static,