Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

Async Open-Meteo API client.

Implementations§

Source§

impl Client

Source

pub fn new() -> Self

Constructs a client using the public free-tier Open-Meteo forecast API.

Panics only if the crate’s built-in default client configuration is invalid or the internal HTTP client cannot be constructed.

Source

pub fn builder() -> ClientBuilder

Starts a custom client builder.

Source

pub fn forecast(&self, latitude: f64, longitude: f64) -> ForecastBuilder<'_>

Starts a general forecast request for one coordinate.

Source

pub fn forecast_batch<I>(&self, locations: I) -> ForecastBatchBuilder<'_>
where I: IntoIterator<Item = (f64, f64)>,

Starts a general forecast request for multiple coordinates.

Source

pub fn forecast_many<I>(&self, locations: I) -> ForecastBatchBuilder<'_>
where I: IntoIterator<Item = (f64, f64)>,

Source

pub fn archive( &self, latitude: f64, longitude: f64, start_date: Date, end_date: Date, ) -> ArchiveBuilder<'_>

Starts an archive request for one coordinate and an inclusive date range.

Source

pub fn historical_forecast( &self, latitude: f64, longitude: f64, start_date: Date, end_date: Date, ) -> HistoricalForecastBuilder<'_>

Starts a historical forecast request for one coordinate and an inclusive date range.

Source

pub fn previous_runs( &self, latitude: f64, longitude: f64, ) -> PreviousRunsBuilder<'_>

Starts a previous model runs request for one coordinate.

Source

pub fn ensemble(&self, latitude: f64, longitude: f64) -> EnsembleBuilder<'_>

Starts an ensemble forecast request for one coordinate.

Source

pub fn seasonal(&self, latitude: f64, longitude: f64) -> SeasonalBuilder<'_>

Starts a seasonal forecast request for one coordinate.

Source

pub fn climate( &self, latitude: f64, longitude: f64, start_date: Date, end_date: Date, ) -> ClimateBuilder<'_>

Starts a climate projection request for one coordinate and an inclusive date range.

Source

pub fn satellite_radiation( &self, latitude: f64, longitude: f64, ) -> SatelliteRadiationBuilder<'_>

Starts a satellite-radiation request for one coordinate.

Source

pub fn flood(&self, latitude: f64, longitude: f64) -> FloodBuilder<'_>

Starts a flood forecast request for one coordinate.

Source

pub fn marine(&self, latitude: f64, longitude: f64) -> MarineBuilder<'_>

Starts a marine forecast request for one coordinate.

Source

pub fn air_quality( &self, latitude: f64, longitude: f64, ) -> AirQualityBuilder<'_>

Starts an air-quality request for one coordinate.

Source

pub fn geocode(&self, name: impl Into<String>) -> GeocodingBuilder<'_>

Starts a geocoding request by place name.

use openmeteo_rs::Client;

let client = Client::new();
let locations = client
    .geocode("Zurich")
    .count(1)
    .language("en")
    .send()
    .await?;

if let Some(location) = locations.first() {
    println!("{}, {}", location.latitude, location.longitude);
}
Source§

impl Client

Source

pub async fn elevation<I>(&self, points: I) -> Result<Vec<Option<f32>>>
where I: IntoIterator<Item = (f64, f64)>,

Looks up elevations for one or more coordinates.

Returned values are metres above sea level and preserve the input coordinate order. A value is None when Open-Meteo has no elevation coverage for that coordinate. Open-Meteo accepts at most 100 coordinate pairs per elevation request.

use openmeteo_rs::Client;

let client = Client::new();
let elevations = client
    .elevation([(52.52, 13.41), (47.3769, 8.5417)])
    .await?;

assert_eq!(elevations.len(), 2);

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Client

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more