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>,
}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,
bitwarden_client_version: None,
bitwarden_package_type: None,
device_identifier: None,
};
let default = ClientSettings::default();Fields§
§identity_url: StringThe identity url of the targeted Bitwarden instance. Defaults to https://identity.bitwarden.com
api_url: StringThe api url of the targeted Bitwarden instance. Defaults to https://api.bitwarden.com
user_agent: StringThe user_agent to sent to Bitwarden. Defaults to Bitwarden Rust-SDK
device_type: DeviceTypeDevice 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 Clone for ClientSettings
impl Clone for ClientSettings
§fn clone(&self) -> ClientSettings
fn clone(&self) -> ClientSettings
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more§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
§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>,
§impl<UT> FfiConverter<UT> for ClientSettings
impl<UT> FfiConverter<UT> for ClientSettings
§const TYPE_ID_META: MetadataBuffer
const TYPE_ID_META: MetadataBuffer
§type FfiType = RustBuffer
type FfiType = RustBuffer
§fn lower(v: ClientSettings) -> RustBuffer
fn lower(v: ClientSettings) -> RustBuffer
§fn try_lift(buf: RustBuffer) -> Result<ClientSettings, Error>
fn try_lift(buf: RustBuffer) -> Result<ClientSettings, Error>
§impl FromWasm for ClientSettings
Available on crate feature wasm only.
impl FromWasm for ClientSettings
wasm only.§type Wire = Ts<ClientSettings>
type Wire = Ts<ClientSettings>
§fn from_wire(
wire: <ClientSettings as FromWasm>::Wire,
) -> Result<ClientSettings, WireError>
fn from_wire( wire: <ClientSettings as FromWasm>::Wire, ) -> Result<ClientSettings, WireError>
§impl JsonSchema for ClientSettings
impl JsonSchema for ClientSettings
§fn schema_name() -> Cow<'static, str>
fn schema_name() -> Cow<'static, str>
§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
§fn inline_schema() -> bool
fn inline_schema() -> bool
$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>
§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
§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>
§fn lift_foreign_return(
ffi_return: Self::ReturnType,
call_status: RustCallStatus,
) -> Self
fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self
§fn lift_error(_buf: RustBuffer) -> Self
fn lift_error(_buf: RustBuffer) -> Self
§fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self
fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self
§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
§impl<UT> LowerError<UT> for ClientSettings
impl<UT> LowerError<UT> for ClientSettings
§fn lower_error(obj: ClientSettings) -> RustBuffer
fn lower_error(obj: ClientSettings) -> RustBuffer
§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
§fn lower_return(
v: ClientSettings,
) -> Result<<ClientSettings as LowerReturn<UT>>::ReturnType, RustCallError>
fn lower_return( v: ClientSettings, ) -> Result<<ClientSettings as LowerReturn<UT>>::ReturnType, RustCallError>
§fn handle_failed_lift(
error: LiftArgsError,
) -> Result<Self::ReturnType, RustCallError>
fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>
§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,
§impl ToWasm for ClientSettings
Available on crate feature wasm only.
impl ToWasm for ClientSettings
wasm only.§type Wire = Ts<ClientSettings>
type Wire = Ts<ClientSettings>
§fn to_wire(self) -> Result<<ClientSettings as ToWasm>::Wire, WireError>
fn to_wire(self) -> Result<<ClientSettings as ToWasm>::Wire, WireError>
§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 * 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
type JsType = JsType
#[wasm_bindgen] extern "C" { .. }.
[Ts<T>] is #[repr(transparent)] over this and passes it across the
ABI as a plain JS handle, which any other representation would break.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
Auto Trait Implementations§
impl Freeze for ClientSettings
impl RefUnwindSafe for ClientSettings
impl Send for ClientSettings
impl Sync for ClientSettings
impl Unpin for ClientSettings
impl UnsafeUnpin for ClientSettings
impl UnwindSafe for ClientSettings
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
§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> ⓘ
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