Struct at_api_rs::Realtime[−][src]

pub struct Realtime<'a> { /* fields omitted */ }
Expand description

A client for interacting with the Auckland Transport GTFS realtime API.

Implementations

impl<'a> Realtime<'a>[src]

pub fn new(api_key: &'a str) -> Self[src]

Creates a new Auckland Transport GTFS realtime client.

Parameters

  • api_key - The API key to use when interacting with the API.

pub async fn fetch_combined<'b>(
    &self,
    trip_ids: Option<&Vec<&'b str>>,
    vehicle_ids: Option<&Vec<&'b str>>
) -> Result<(Header, Vec<Entity>)>[src]

Fetches both trip updates and vehicle positions from the AT API.

AT sends the trip updates and vehicle positions seperate, these are joined together upon collection in the function, joined by trip ID.

Parameters can be used to query for specific vehicles or trips. If None is given for both fields, all vehicles will be returned.

Parameters

  • trip_ids - A list of trip IDs to search for.
  • vehicle_ids - A list of vehicle IDs to search for.

Returns

Returns a tuple where the first item is the response header received from AT, and the second item is a vector of AT vehicles.

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Realtime<'a>

impl<'a> Send for Realtime<'a>

impl<'a> Sync for Realtime<'a>

impl<'a> Unpin for Realtime<'a>

impl<'a> !UnwindSafe for Realtime<'a>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

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

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

fn in_current_span(self) -> Instrumented<Self>[src]

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

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.