Struct ClientBuilder 

pub struct ClientBuilder {
    settings: Option<ClientSettings>,
    token_handler: Arc<dyn TokenHandler>,
    state_registry: Option<StateRegistry>,
    middleware: Vec<Arc<dyn Middleware>>,
    managed_profile: Option<Arc<RwLock<Option<ManagementProfile>>>>,
    api_configurations: Option<Arc<ApiConfigurations>>,
}

Builder for constructing Client instances with custom configuration.

Fields

settings: Option<ClientSettings>

token_handler: Arc<dyn TokenHandler>

state_registry: Option<StateRegistry>

middleware: Vec<Arc<dyn Middleware>>

managed_profile: Option<Arc<RwLock<Option<ManagementProfile>>>>

api_configurations: Option<Arc<ApiConfigurations>>

Implementations

impl ClientBuilder

pub fn new() -> Self

Creates a new ClientBuilder with default settings.

pub fn with_api_configurations( self, api_configurations: Arc<ApiConfigurations>, ) -> Self

Overrides the ApiConfigurations used by the client being built, allowing tests to inject a mocked [bitwarden_api_api::apis::ApiClient] via ApiConfigurations::from_api_client. Only available for testing.

pub fn with_settings(self, settings: ClientSettings) -> Self

Sets the ClientSettings for the client being built.

pub fn with_token_handler(self, token_handler: Arc<dyn TokenHandler>) -> Self

Sets a custom TokenHandler for managing authentication tokens.

pub fn with_middleware(self, middleware: Vec<Arc<dyn Middleware>>) -> Self

Sets additional middleware to be chained outermost (before auth middleware).

pub fn with_state(self, state_registry: StateRegistry) -> Self

Sets a custom StateRegistry for the client being built. If not set, defaults to StateRegistry::new_with_memory_db.

pub fn with_managed_profile( self, cell: Arc<RwLock<Option<ManagementProfile>>>, ) -> Self

Low-level hook to store a managed-settings profile cell, shared with the host application that pushes profiles into it. Defaults to a fresh empty cell when not set.

The ManagedSettingsClient in bitwarden-managed-settings supplies the cell. Instantiate the client through that crate instead of calling this directly.

pub fn build(self) -> Client

Consumes the builder and constructs a Client.

Trait Implementations

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.