Struct ClientSettings
pub struct ClientSettings {
pub identity_url: String,
pub api_url: String,
pub user_agent: String,
pub device_type: DeviceType,
}
Expand description
Basic client behavior settings. These settings specify the various targets and behavior of the Bitwarden Client. They are optional and uneditable once the client is initialized.
Defaults to
let settings = ClientSettings {
identity_url: "https://identity.bitwarden.com".to_string(),
api_url: "https://api.bitwarden.com".to_string(),
user_agent: "Bitwarden Rust-SDK".to_string(),
device_type: DeviceType::SDK,
};
let default = ClientSettings::default();
Fields§
§identity_url: String
The identity url of the targeted Bitwarden instance. Defaults to https://identity.bitwarden.com
api_url: String
The api url of the targeted Bitwarden instance. Defaults to https://api.bitwarden.com
user_agent: String
The user_agent to sent to Bitwarden. Defaults to Bitwarden Rust-SDK
device_type: DeviceType
Device type to send to Bitwarden. Defaults to SDK
Trait Implementations§
§impl<UT> ConvertError<UT> for ClientSettings
impl<UT> ConvertError<UT> for ClientSettings
fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<ClientSettings, Error>
§impl Debug for ClientSettings
impl Debug for ClientSettings
§impl Default for ClientSettings
impl Default for ClientSettings
§fn default() -> ClientSettings
fn default() -> ClientSettings
Returns the “default value” for a type. Read more
§impl<'de> Deserialize<'de> for ClientSettingswhere
ClientSettings: Default,
impl<'de> Deserialize<'de> for ClientSettingswhere
ClientSettings: Default,
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<ClientSettings, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<ClientSettings, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
§impl<UT> FfiConverter<UT> for ClientSettings
impl<UT> FfiConverter<UT> for ClientSettings
§const TYPE_ID_META: MetadataBuffer = _
const TYPE_ID_META: MetadataBuffer = _
Type ID metadata, serialized into a [MetadataBuffer].
§type FfiType = RustBuffer
type FfiType = RustBuffer
The low-level type used for passing values of this type over the FFI. Read more
§fn lower(v: ClientSettings) -> RustBuffer
fn lower(v: ClientSettings) -> RustBuffer
Lower a rust value of the target type, into an FFI value of type Self::FfiType. Read more
§fn try_lift(buf: RustBuffer) -> Result<ClientSettings, Error>
fn try_lift(buf: RustBuffer) -> Result<ClientSettings, Error>
Lift a rust value of the target type, from an FFI value of type Self::FfiType. Read more
§impl From<ClientSettings> for JsValuewhere
ClientSettings: Serialize,
impl From<ClientSettings> for JsValuewhere
ClientSettings: Serialize,
§fn from(value: ClientSettings) -> JsValue
fn from(value: ClientSettings) -> JsValue
Converts to this type from the input type.
§impl FromWasmAbi for ClientSettingswhere
ClientSettings: DeserializeOwned,
impl FromWasmAbi for ClientSettingswhere
ClientSettings: DeserializeOwned,
§type Abi = <JsType as FromWasmAbi>::Abi
type Abi = <JsType as FromWasmAbi>::Abi
The wasm ABI type that this converts from when coming back out from the
ABI boundary.
§unsafe fn from_abi(js: <ClientSettings as FromWasmAbi>::Abi) -> ClientSettings
unsafe fn from_abi(js: <ClientSettings as FromWasmAbi>::Abi) -> ClientSettings
§impl IntoWasmAbi for ClientSettingswhere
ClientSettings: Serialize,
impl IntoWasmAbi for ClientSettingswhere
ClientSettings: Serialize,
§type Abi = <JsType as IntoWasmAbi>::Abi
type Abi = <JsType as IntoWasmAbi>::Abi
The wasm ABI type that this converts into when crossing the ABI
boundary.
§fn into_abi(self) -> <ClientSettings as IntoWasmAbi>::Abi
fn into_abi(self) -> <ClientSettings as IntoWasmAbi>::Abi
Convert
self
into Self::Abi
so that it can be sent across the wasm
ABI boundary.§impl JsonSchema for ClientSettings
impl JsonSchema for ClientSettings
§fn schema_name() -> String
fn schema_name() -> String
The name of the generated JSON Schema. Read more
§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Returns a string that uniquely identifies the schema produced by this type. Read more
§fn json_schema(gen: &mut SchemaGenerator) -> Schema
fn json_schema(gen: &mut SchemaGenerator) -> Schema
Generates a JSON Schema for this type. Read more
§fn is_referenceable() -> bool
fn is_referenceable() -> bool
Whether JSON Schemas generated for this type should be re-used where possible using the
$ref
keyword. Read more§impl<UT> Lift<UT> for ClientSettings
impl<UT> Lift<UT> for ClientSettings
type FfiType = <ClientSettings as FfiConverter<UT>>::FfiType
fn try_lift( v: <ClientSettings as Lift<UT>>::FfiType, ) -> Result<ClientSettings, Error>
fn try_read(buf: &mut &[u8]) -> Result<ClientSettings, Error>
§fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>
fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>
Convenience method
§impl<UT> LiftRef<UT> for ClientSettings
impl<UT> LiftRef<UT> for ClientSettings
type LiftType = ClientSettings
§impl<UT> LiftReturn<UT> for ClientSettings
impl<UT> LiftReturn<UT> for ClientSettings
§type ReturnType = <ClientSettings as Lift<UT>>::FfiType
type ReturnType = <ClientSettings as Lift<UT>>::FfiType
FFI return type for trait interfaces
§fn try_lift_successful_return(
v: <ClientSettings as LiftReturn<UT>>::ReturnType,
) -> Result<ClientSettings, Error>
fn try_lift_successful_return( v: <ClientSettings as LiftReturn<UT>>::ReturnType, ) -> Result<ClientSettings, Error>
Lift a successfully returned value from a trait interface
§fn lift_foreign_return(
ffi_return: Self::ReturnType,
call_status: RustCallStatus,
) -> Self
fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self
Lift a foreign returned value from a trait interface Read more
§fn lift_error(_buf: RustBuffer) -> Self
fn lift_error(_buf: RustBuffer) -> Self
Lift a Rust value for a callback interface method error result Read more
§fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self
fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self
Lift a Rust value for an unexpected callback interface error Read more
§impl<UT> Lower<UT> for ClientSettings
impl<UT> Lower<UT> for ClientSettings
type FfiType = <ClientSettings as FfiConverter<UT>>::FfiType
fn lower(obj: ClientSettings) -> <ClientSettings as Lower<UT>>::FfiType
fn write(obj: ClientSettings, buf: &mut Vec<u8>)
§fn lower_into_rust_buffer(obj: Self) -> RustBuffer
fn lower_into_rust_buffer(obj: Self) -> RustBuffer
Convenience method
§impl<UT> LowerError<UT> for ClientSettings
impl<UT> LowerError<UT> for ClientSettings
§fn lower_error(obj: ClientSettings) -> RustBuffer
fn lower_error(obj: ClientSettings) -> RustBuffer
Lower this value for scaffolding function return Read more
§impl<UT> LowerReturn<UT> for ClientSettings
impl<UT> LowerReturn<UT> for ClientSettings
§type ReturnType = <ClientSettings as Lower<UT>>::FfiType
type ReturnType = <ClientSettings as Lower<UT>>::FfiType
The type that should be returned by scaffolding functions for this type. Read more
§fn lower_return(
v: ClientSettings,
) -> Result<<ClientSettings as LowerReturn<UT>>::ReturnType, RustCallError>
fn lower_return( v: ClientSettings, ) -> Result<<ClientSettings as LowerReturn<UT>>::ReturnType, RustCallError>
Lower the return value from an scaffolding call Read more
§fn handle_failed_lift(
error: LiftArgsError,
) -> Result<Self::ReturnType, RustCallError>
fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>
Lower the return value for failed argument lifts Read more
§impl OptionFromWasmAbi for ClientSettingswhere
ClientSettings: DeserializeOwned,
impl OptionFromWasmAbi for ClientSettingswhere
ClientSettings: DeserializeOwned,
§fn is_none(js: &<ClientSettings as FromWasmAbi>::Abi) -> bool
fn is_none(js: &<ClientSettings as FromWasmAbi>::Abi) -> bool
Tests whether the argument is a “none” instance. If so it will be
deserialized as
None
, and otherwise it will be passed to
FromWasmAbi
.§impl OptionIntoWasmAbi for ClientSettingswhere
ClientSettings: Serialize,
impl OptionIntoWasmAbi for ClientSettingswhere
ClientSettings: Serialize,
§fn none() -> <ClientSettings as IntoWasmAbi>::Abi
fn none() -> <ClientSettings as IntoWasmAbi>::Abi
Returns an ABI instance indicating “none”, which JS will interpret as
the
None
branch of this option. Read more§impl RefFromWasmAbi for ClientSettingswhere
ClientSettings: DeserializeOwned,
impl RefFromWasmAbi for ClientSettingswhere
ClientSettings: DeserializeOwned,
§type Abi = <JsType as RefFromWasmAbi>::Abi
type Abi = <JsType as RefFromWasmAbi>::Abi
The wasm ABI type references to
Self
are recovered from.§type Anchor = SelfOwner<ClientSettings>
type Anchor = SelfOwner<ClientSettings>
The type that holds the reference to
Self
for the duration of the
invocation of the function that has an &Self
parameter. This is
required to ensure that the lifetimes don’t persist beyond one function
call, and so that they remain anonymous.§unsafe fn ref_from_abi(
js: <ClientSettings as RefFromWasmAbi>::Abi,
) -> <ClientSettings as RefFromWasmAbi>::Anchor
unsafe fn ref_from_abi( js: <ClientSettings as RefFromWasmAbi>::Abi, ) -> <ClientSettings as RefFromWasmAbi>::Anchor
§impl Serialize for ClientSettings
impl Serialize for ClientSettings
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
§impl Tsify for ClientSettings
impl Tsify for ClientSettings
const DECL: &'static str = "/**\n * Basic client behavior settings. These settings specify the various targets and behavior of the\n * Bitwarden Client. They are optional and uneditable once the client is initialized.\n *\n * Defaults to\n *\n * ```\n * # use bitwarden_core::{ClientSettings, DeviceType};\n * let settings = ClientSettings {\n * identity_url: \\\"https://identity.bitwarden.com\\\".to_string(),\n * api_url: \\\"https://api.bitwarden.com\\\".to_string(),\n * user_agent: \\\"Bitwarden Rust-SDK\\\".to_string(),\n * device_type: DeviceType::SDK,\n * };\n * let default = ClientSettings::default();\n * ```\n */\nexport interface ClientSettings {\n /**\n * The identity url of the targeted Bitwarden instance. Defaults to `https://identity.bitwarden.com`\n */\n identityUrl?: string;\n /**\n * The api url of the targeted Bitwarden instance. Defaults to `https://api.bitwarden.com`\n */\n apiUrl?: string;\n /**\n * The user_agent to sent to Bitwarden. Defaults to `Bitwarden Rust-SDK`\n */\n userAgent?: string;\n /**\n * Device type to send to Bitwarden. Defaults to SDK\n */\n deviceType?: DeviceType;\n}"
const SERIALIZATION_CONFIG: SerializationConfig = _
type JsType = JsType
fn into_js(&self) -> Result<Self::JsType, Error>where
Self: Serialize,
fn from_js<T>(js: T) -> Result<Self, Error>
§impl<UT> TypeId<UT> for ClientSettings
impl<UT> TypeId<UT> for ClientSettings
const TYPE_ID_META: MetadataBuffer = _
§impl VectorFromWasmAbi for ClientSettingswhere
ClientSettings: DeserializeOwned,
impl VectorFromWasmAbi for ClientSettingswhere
ClientSettings: DeserializeOwned,
type Abi = <JsType as VectorFromWasmAbi>::Abi
unsafe fn vector_from_abi( js: <ClientSettings as VectorFromWasmAbi>::Abi, ) -> Box<[ClientSettings]>
§impl VectorIntoWasmAbi for ClientSettingswhere
ClientSettings: Serialize,
impl VectorIntoWasmAbi for ClientSettingswhere
ClientSettings: Serialize,
type Abi = <JsType as VectorIntoWasmAbi>::Abi
fn vector_into_abi( vector: Box<[ClientSettings]>, ) -> <ClientSettings as VectorIntoWasmAbi>::Abi
Auto Trait Implementations§
impl Freeze for ClientSettings
impl RefUnwindSafe for ClientSettings
impl Send for ClientSettings
impl Sync for ClientSettings
impl Unpin for ClientSettings
impl UnwindSafe for ClientSettings
Blanket Implementations§
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
Mutably borrows from an owned value. Read more
§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
Create a new handle for an Arc value Read more
§unsafe fn clone_handle(handle: Handle) -> Handle
unsafe fn clone_handle(handle: Handle) -> Handle
Clone a handle Read more
§unsafe fn consume_handle(handle: Handle) -> Arc<T>
unsafe fn consume_handle(handle: Handle) -> Arc<T>
Consume a handle, getting back the initial
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>
Converts
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>
Converts
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§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
source§type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
Same as
IntoWasmAbi::Abi
source§fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
Same as
IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
.