Struct ClientOptions

pub struct ClientOptions {
    pub api_key: String,
    pub language: String,
    pub units: UnitSystem,
}

Options to configure the Client.

Fields

api_key: String

An api key required to call the API.

language: String

See https://openweathermap.org/current#multi for currently supported languages. This library will not attempt to validate the language passed in.

units: UnitSystem

Controls the units of certain metrics returned from the API.

Implementations

impl ClientOptions

pub fn default_api_key() -> String

pub fn default_language() -> String

Defaults to “en”

pub fn default_units() -> UnitSystem

Defaults to UnitSystem::Metric

pub fn masked_api_key(&self) -> String

Returns the API key with most of the characters masked out.

pub fn validate(&self) -> Result<(), InvalidOptionsError>

Ensures an api_key is provided

Errors

Errors that cannot be validated during input parsing.

pub fn mask_api_key_if_present(&self, any_string: &str) -> String

Take an arbitrary string that might have the self.api_key in it and returns a string with that all occurrences of the key masked.

Trait Implementations

impl Clone for ClientOptions

fn clone(&self) -> ClientOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientOptions

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

Formats the value using the given formatter.

impl Default for ClientOptions

fn default() -> Self

Useful for creating options with an API Key specified in the environment variable API_KEY and with defaults of “en”, Metric, 1 call/sercond.

impl<'de> Deserialize<'de> for ClientOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.