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 Debug for ClientSettings

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

Formats the value using the given formatter.

impl Default for ClientSettings

fn default() -> Self

Returns the “default value” for a type.

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

where ClientSettings: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for ClientSettings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.