Skip to main content

ClientBuilder

Struct ClientBuilder 

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

Builder for configuring and constructing a VaultClient

Implementations§

Source§

impl ClientBuilder

Source

pub fn from_env() -> Self

Pre-populate the builder from VAULT_* environment variables; token resolution order: VAULT_TOKEN~/.vault-tokenNone

Source

pub fn address(self, addr: &str) -> Self

Source

pub fn token(self, token: SecretString) -> Self

Source

pub fn token_str(self, token: &str) -> Self

Source

pub fn namespace(self, ns: &str) -> Self

Source

pub fn timeout(self, timeout: Duration) -> Self

Source

pub fn max_retries(self, n: u32) -> Self

Source

pub fn initial_retry_delay(self, d: Duration) -> Self

Source

pub fn wrap_ttl(self, ttl: &str) -> Self

Source

pub fn forward_to_leader(self, yes: bool) -> Self

Source

pub fn cli_mode(self, yes: bool) -> Self

Optimise for short-lived CLI invocations

Sets max_retries(0) and disables sealed-Vault retries — a sealed Vault will not unseal itself between invocations — equivalent to VAULT_CLI_MODE=1 in from_env()

Source

pub fn danger_disable_tls_verify(self, yes: bool) -> Self

Source

pub fn ca_cert_pem(self, pem: impl Into<Vec<u8>>) -> Self

Source

pub fn client_cert_pem( self, cert: impl Into<Vec<u8>>, key: impl Into<Vec<u8>>, ) -> Self

Source

pub fn auth_method(self, method: impl AuthMethod + 'static) -> Self

Set an authentication method for automatic token lifecycle management

When set, the client will automatically re-authenticate when the token nears expiry or is missing

Source

pub fn circuit_breaker(self, config: CircuitBreakerConfig) -> Self

Enable the circuit breaker with the given configuration

When enabled, consecutive failures will trip the circuit and short-circuit subsequent requests until the reset timeout elapses

Source

pub fn on_token_changed( self, f: impl Fn(&AuthInfo) + Send + Sync + 'static, ) -> Self

Register a callback invoked whenever the client’s token changes via renewal or re-authentication

Source

pub fn with_reqwest_client(self, client: Client) -> Self

Source

pub fn build(self) -> Result<VaultClient, VaultError>

Trait Implementations§

Source§

impl Default for ClientBuilder

Source§

fn default() -> ClientBuilder

Returns the “default value” for a type. Read more

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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