Struct rparif::client::RParifClient

pub struct RParifClient<'a> { /* fields omitted */ }

Client to call HTTP API

Implementations

impl<'_> RParifClient<'_>

pub fn new(api_key: &str) -> RParifClient

Construct a new client

Arguments

• api_key - API key to authenticate call

pub fn new_test(api_key: &str) -> RParifClient

Constructor used for test with httpmock. It use http://localhost:5000 as URL to call mock instead of real services

Arguments

• api_key - any string

pub fn index(&self) -> Result<Vec<Index>, RParifError>

Access global pollution index for previous day, current day and next day through indice endpoint

Errors

• RParifError::RequestError when reqwest lib fails. It contains the underlying error.

• RParifError::CallError when HTTP status is other than 2XX. It contains the URL called, the HTTP status and the body response

• RParifError::UnexpectedDate if the date can't be parsed (see convert_json_to_date)

• RParifError::MissingJsonKey if missing JSON is missing ìndice

• RParifError::WrongJsonType if ìndice is not a number or if JSON is not as expected

• RParifError::JsonError if response isn't a well formed JSON

pub fn index_day(&self, day: Day) -> Result<Vec<Index>, RParifError>

Retrieve index pollution (global and per pollutant) for a given date (previous day, current or next day) using indiceJour endpoint

Arguments

• day - Which day to get indices pollution for

Errors

• RParifError::RequestError when reqwest lib fails. It contains the underlying error.

• RParifError::CallError when HTTP status is other than 2XX. It contains the URL called, the HTTP status and the body response

• RParifError::MissingJsonKey if missing JSON is missing ìndice or date

• RParifError::WrongJsonType if ìndice is not a number or if date isn't a string

• RParifError::DateParseError if date is not in dd/mm/yyyy format

• RParifError::JsonError if response isn't a well formed JSON

pub fn index_city(&self, cities: Vec<&str>) -> Result<Vec<Index>, RParifError>

Allow to get pollution indices for multiple cities through idxville endpoint.
The indes is the combination of indices for all pollutants listed in index

Arguments

• cities - List of INSEE city code. See here or here to find corresponding code

Errors

• RParifError::RequestError when reqwest lib fails. It contains the underlying error.

• RParifError::CallError when HTTP status is other than 2XX. It contains the URL called, the HTTP status and the body response

• RParifError::UnexpectedDate if the date can't be parsed (see convert_string_to_date)

• RParifError::MissingJsonKey if missing JSON is missing ninsee or indice

• RParifError::WrongJsonType if ninsee isn't a string or indice is not a number or if JSON is not as expected

• RParifError::JsonError if response isn't a well formed JSON

pub fn episode(&self) -> Result<Vec<Episode>, RParifError>

List pollution alert for previous day, current day and next day using episode endpoint

Errors

• RParifError::RequestError when reqwest lib fails. It contains the underlying error.

• RParifError::CallError when HTTP status is other than 2XX. It contains the URL called, the HTTP status and the body response

• RParifError::UnexpectedDate if the date can't be parsed (see convert_json_to_date)

• RParifError::MissingJsonKey if missing JSON is missing type or niveau

• RParifError::UnkownEnumValue if type or niveau can't be converted into corresponding enum variant

• RParifError::WrongJsonType if type or niveau is not a string or if JSON is not as expected

• RParifError::JsonError if response isn't a well formed JSON

Trait Implementations

impl<'a> Debug for RParifClient<'a>

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

Formats the value using the given formatter.