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>
impl<'a> Realtime<'a>
Sourcepub fn new(api_key: &'a str) -> Self
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.
Sourcepub async fn fetch_combined<'b>(
&self,
trip_ids: Option<&Vec<&'b str>>,
vehicle_ids: Option<&Vec<&'b str>>,
) -> Result<(Header, Vec<Entity>)>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more