Struct openmensa_rs::request::CanteenRequest

pub struct CanteenRequest { /* fields omitted */ }

Struct to create a request receiving a list of canteens fitting the specified parameters.

This request does not require any additional information and can be stated as is to retrieve a list of all canteens.

Example

use openmensa_rs::request::CanteenRequest;
use openmensa_rs::CoordinatePair;

let near_canteens = CanteenRequest::new()
    .with_near_coordinates(
        CoordinatePair::new(
            52.1396188273019,
            11.6475999355316,
        )
    )
    .build()
    .await
    .unwrap();

Implementations

impl CanteenRequest

pub fn new() -> Self

Returns a new instance of a request. If you want to perform the same request again, you do not need to set all parameters anew. Requests are clonable, so to not lose them after building just create a clone!

use openmensa_rs::request::CanteenRequest;

let my_super_complex_request = CanteenRequest::new();
let result = my_super_complex_request.clone().build().await.unwrap();
// And we can use it again!
let result = my_super_complex_request.build().await.unwrap();

pub fn with_near_coordinates(self, near: CoordinatePair) -> Self

Specify a CoordinatePair to which the canteen should be near to. If not further specified only canteens in a range of up to 10 kilometers will be returned. If you want to specify the range too, have a look at with_distance_to method.

pub fn with_distance_to(self, dst: f32, near: CoordinatePair) -> Self

Specify a CoordinatePair and distance to which the canteen should be near too.

pub fn with_id<U: Into<u16>>(self, id: U) -> Self

Add an id that should be included in the response.

Note: If at least one id is specified, only these ids will be included in the response. Even if other canteens would also match all other parameters. The same is true vice versa.

pub fn with_ids<T: Iterator>(self, ids: T) -> Self where
    T::Item: Into<u16>, 

Add multiple ids to the request.

pub fn with_coordinates_requisite(self) -> Self

Return only canteens that have specified coordinates.

pub async fn build(self) -> Result<Vec<Canteen>, RequestError>

Send the request and wait for the response. May return an error if the parameters cannot be serialized or the response cannot be deserialized.

let near_canteens = CanteenRequest::new()
    .with_near_coordinates(
        CoordinatePair::new(
            52.1396188273019,
            11.6475999355316,
        )
    )
    .build()
    .await
    .unwrap();

Trait Implementations

impl Clone for CanteenRequest

fn clone(&self) -> CanteenRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for CanteenRequest

fn default() -> CanteenRequest

Returns the “default value” for a type.

impl Serialize for CanteenRequest

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.