pub struct Client { /* private fields */ }Expand description
The main struct to interact with the Bitwarden SDK.
Implementations§
Source§impl Client
impl Client
Sourcepub fn new(settings: Option<ClientSettings>) -> Self
pub fn new(settings: Option<ClientSettings>) -> Self
Create a new Bitwarden client with default settings and a no-op token handler.
Sourcepub fn new_with_token_handler(
settings: Option<ClientSettings>,
token_handler: Arc<dyn TokenHandler>,
) -> Self
pub fn new_with_token_handler( settings: Option<ClientSettings>, token_handler: Arc<dyn TokenHandler>, ) -> Self
Create a new Bitwarden client with the specified token handler for managing authentication tokens.
Sourcepub fn builder() -> ClientBuilder
pub fn builder() -> ClientBuilder
Returns a ClientBuilder for constructing a new Client.
Source§impl Client
impl Client
Sourcepub async fn save_to_state(
data: SaveStateData,
reg: &StateRegistry,
) -> Result<(), RehydrationError>
pub async fn save_to_state( data: SaveStateData, reg: &StateRegistry, ) -> Result<(), RehydrationError>
Populates a StateRegistry with the state required for Client::load_from_state.
Call this after a successful login to persist the values that the auth flow does not yet write automatically. Once the auth crate handles persistence directly, this will be removed.
Sourcepub async fn load_from_state(
token_handler: Arc<dyn TokenHandler>,
registry: StateRegistry,
) -> Result<Self, RehydrationError>
pub async fn load_from_state( token_handler: Arc<dyn TokenHandler>, registry: StateRegistry, ) -> Result<Self, RehydrationError>
Reconstruct a locked Client from a populated StateRegistry.
Does NOT unlock the vault.
Source§impl Client
impl Client
Sourcepub fn new_test(settings: Option<ClientSettings>) -> Self
pub fn new_test(settings: Option<ClientSettings>) -> Self
Creates a client with the necessary state repositories for testing. Does not initialize any crypto state.
pub async fn init_test_account(account: TestAccount) -> Self
Source§impl Client
impl Client
Sourcepub fn km_state_bridge(&self) -> StateBridgeClient
pub fn km_state_bridge(&self) -> StateBridgeClient
A temporary client to bridge KM state into the SDK.
Trait Implementations§
Source§impl FromClientPart<Arc<ApiConfigurations>> for Client
impl FromClientPart<Arc<ApiConfigurations>> for Client
Source§fn get_part(&self) -> Arc<ApiConfigurations>
fn get_part(&self) -> Arc<ApiConfigurations>
T from self.Source§impl FromClientPart<KeyStore<KeySlotIds>> for Client
impl FromClientPart<KeyStore<KeySlotIds>> for Client
Source§fn get_part(&self) -> KeyStore<KeySlotIds>
fn get_part(&self) -> KeyStore<KeySlotIds>
T from self.Source§impl<T: RepositoryItem> FromClientPart<Option<Arc<dyn Repository<T>>>> for Client
Available on crate feature internal only.
impl<T: RepositoryItem> FromClientPart<Option<Arc<dyn Repository<T>>>> for Client
internal only.Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl UnsafeUnpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
§impl<T> AnySync for T
impl<T> AnySync for T
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> CompatExt for T
impl<T> CompatExt for T
§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
§fn new_handle(value: Arc<T>) -> Handle
fn new_handle(value: Arc<T>) -> Handle
§unsafe fn clone_handle(handle: Handle) -> Handle
unsafe fn clone_handle(handle: Handle) -> Handle
§unsafe fn consume_handle(handle: Handle) -> Arc<T>
unsafe fn consume_handle(handle: Handle) -> Arc<T>
Arc<> Read more§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more