Struct AstroEventRequest 

pub struct AstroEventRequest<A = ProvidedArgument, B = ProvidedArgument, C = ProvidedArgument> { /* private fields */ }

Astronomy API requests. Astro Event API request.

Request is validated at compile time when supplied to the client.

Example:

use libtad_rs::{
    ServiceClient,
    service::astronomy::AstroEventRequest,
    models::{
        astronomy::AstronomyObjectType,
        time::DateTime,
    },
};

let client = ServiceClient::new("access_key".into(), "secret_key".into());
let request = AstroEventRequest::new()
    .with_object(AstronomyObjectType::Sun)
    .with_placeid("3")
    .set_startdt(DateTime::from("2021-08-18"));

let response = client.get_astro_events(&request);

Implementations

impl AstroEventRequest

pub fn new() -> AstroEventRequest<RequiredArgument, RequiredArgument, RequiredArgument>

Start building a new request.

impl<A, B, C> AstroEventRequest<A, B, C>

pub fn set_object( self, object: Vec<AstronomyObjectType>, ) -> AstroEventRequest<ProvidedArgument, B, C>

Set a list of objects for the request.

pub fn with_object( self, object: AstronomyObjectType, ) -> AstroEventRequest<ProvidedArgument, B, C>

Add an object to the request.

pub fn set_placeid( self, placeid: Vec<impl Into<String>>, ) -> AstroEventRequest<A, ProvidedArgument, C>

Set a list of placeids for the request.

pub fn with_placeid( self, placeid: impl Into<String>, ) -> AstroEventRequest<A, ProvidedArgument, C>

Add a placeid to the request.

pub fn set_startdt( self, startdt: DateTime, ) -> AstroEventRequest<A, B, ProvidedArgument>

Set the start date for the request.

pub fn set_enddt(self, enddt: DateTime) -> Self

Set the end date for the request.

pub fn with_type(self, event_type: AstronomyEventClass) -> Self

Add an event type to the request.

pub fn set_geo(self, enable: bool) -> Self

Toggle whether to return longitude and latitude for the geo object.

pub fn set_isotime(self, enable: bool) -> Self

Toggle whether to add time stamps in local time to all events.

pub fn set_lang(self, lang: impl Into<String>) -> Self

Set the request language for the request.

pub fn set_radius(self, radius: i32) -> Self

Set search radius for translating coordinates to locations.

pub fn set_utctime(self, enable: bool) -> Self

Toggle whether to add time stamps in RequiredArgumentTC to all events.

Trait Implementations

impl<A: Default, B: Default, C: Default> Default for AstroEventRequest<A, B, C>

fn default() -> AstroEventRequest<A, B, C>

Returns the “default value” for a type.

impl<A, B, C> Serialize for AstroEventRequest<A, B, C>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.