Struct Realtime

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

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

Implementations§

Source§

impl<'a> Realtime<'a>

Source

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

Creates a new Auckland Transport GTFS realtime client.

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

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

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> Freeze for Realtime<'a>

§

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§

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> 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, 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,