Struct tankerkoenig::api::Tankerkoenig

pub struct Tankerkoenig {
    pub station: StationApi,
    pub price: PriceApi,
}

The main struct of the crate giving access to the StationApi and PriceApi of tankerkoenig. Create a new instance of the struct with your api key as parameter.

Example

use tankerkoenig::Tankerkoenig;
use tankerkoenig::models;

async fn request_station_details() -> Result<models::station::DetailsResponse, tankerkoenig::Error> {
  let tanker = Tankerkoenig::new("your-api-key")?;
  let details = tanker.station.fetch_details("id-of-the-fuel-station").await?;
  Ok(details)
}

Fields

station: StationApi

Provide access to all station related api resources

price: PriceApi

Provide access to all price related api resources

Implementations

impl Tankerkoenig

pub fn new<S>(api_key: S) -> Result<Self, TankerkoenigError>

where S: AsRef<str>,

Creates a new instance of the Tankerkoenig struct by passing your api key as function parameter.

Example

use tankerkoenig::Tankerkoenig;
use tankerkoenig::models;

async fn request_station_details() -> Result<models::station::DetailsResponse, tankerkoenig::Error> {
  let tanker = Tankerkoenig::new("your-api-key")?;
  let details = tanker.station.fetch_details("id-of-the-fuel-station").await?;
  Ok(details)
}

pub fn new_with_useragent<S>( api_key: S, user_agent: S, ) -> Result<Self, TankerkoenigError>

where S: AsRef<str>,

Creates a new instance of the Tankerkoenig struct by passing your api key as first function parameter and your customer user agent as second parameter. Default user agent is the current crate name the version number.

Example

use tankerkoenig::Tankerkoenig;
use tankerkoenig::models;

async fn request_station_details() -> Result<models::station::DetailsResponse, tankerkoenig::Error> {
  let user_agent = "Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion";
  let tanker = Tankerkoenig::new_with_useragent("your-api-key", user_agent)?;
  let details = tanker.station.fetch_details("id-of-the-fuel-station").await?;
  Ok(details)
}

Trait Implementations

impl Clone for Tankerkoenig

fn clone(&self) -> Tankerkoenig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tankerkoenig

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

Formats the value using the given formatter.