Struct ClientSettings 

pub struct ClientSettings {
    pub identity_url: String,
    pub api_url: String,
    pub user_agent: String,
    pub device_type: DeviceType,
    pub device_identifier: Option<String>,
    pub bitwarden_client_version: Option<String>,
    pub bitwarden_package_type: Option<String>,
}

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,
    bitwarden_client_version: None,
    bitwarden_package_type: None,
    device_identifier: None,
};
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

device_identifier: Option<String>

Device identifier to send to Bitwarden. Optional for now in transition period.

bitwarden_client_version: Option<String>

Bitwarden Client Version to send to Bitwarden. Optional for now in transition period.

bitwarden_package_type: Option<String>

Bitwarden Package Type to send to Bitwarden. We should evaluate this field to see if it should be optional later.

Trait Implementations

impl<UT> ConvertError<UT> for ClientSettings

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<ClientSettings, Error>

impl Debug for ClientSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ClientSettings

fn default() -> ClientSettings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientSettings

where ClientSettings: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<ClientSettings, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<UT> FfiConverter<UT> for ClientSettings

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: ClientSettings) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<ClientSettings, Error>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: ClientSettings, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<ClientSettings, Error>

Read a rust value from a buffer, received over the FFI in serialized form.

impl From<ClientSettings> for JsValue

where ClientSettings: Serialize,

fn from(value: ClientSettings) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for ClientSettings

where ClientSettings: DeserializeOwned,

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

Recover a Self from Self::Abi.

impl IntoWasmAbi for ClientSettings

where ClientSettings: Serialize,

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

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsonSchema for ClientSettings

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

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>

Convenience method

impl<UT> LiftRef<UT> for ClientSettings

type LiftType = ClientSettings

impl<UT> LiftReturn<UT> for ClientSettings

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>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

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

Convenience method

impl<UT> LowerError<UT> for ClientSettings

fn lower_error(obj: ClientSettings) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for ClientSettings

type ReturnType = <ClientSettings as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return( v: ClientSettings, ) -> Result<<ClientSettings as LowerReturn<UT>>::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl OptionFromWasmAbi for ClientSettings

where ClientSettings: DeserializeOwned,

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 ClientSettings

where ClientSettings: Serialize,

fn none() -> <ClientSettings as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for ClientSettings

where ClientSettings: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

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

Recover a Self::Anchor from Self::Abi.

impl Serialize for ClientSettings

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.

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 * bitwarden_client_version: None,\n * bitwarden_package_type: None,\n * device_identifier: None,\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 /**\n * Device identifier to send to Bitwarden. Optional for now in transition period.\n */\n deviceIdentifier?: string | undefined;\n /**\n * Bitwarden Client Version to send to Bitwarden. Optional for now in transition period.\n */\n bitwardenClientVersion?: string | undefined;\n /**\n * Bitwarden Package Type to send to Bitwarden. We should evaluate this field to see if it\n * should be optional later.\n */\n bitwardenPackageType?: string | undefined;\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>

where T: Into<JsValue>, Self: DeserializeOwned,

impl<UT> TypeId<UT> for ClientSettings

const TYPE_ID_META: MetadataBuffer

impl VectorFromWasmAbi for ClientSettings

where ClientSettings: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

unsafe fn vector_from_abi( js: <ClientSettings as VectorFromWasmAbi>::Abi, ) -> Box<[ClientSettings]>

impl VectorIntoWasmAbi for ClientSettings

where ClientSettings: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

fn vector_into_abi( vector: Box<[ClientSettings]>, ) -> <ClientSettings as VectorIntoWasmAbi>::Abi