Struct lta::blocking::client::LTAClient

pub struct LTAClient<T> {
    pub api_key: String,
    pub client: T,
    pub base_url: String,
}

A Client to make requests with The Client holds a connection pool internally, so it is advised that you create one and reuse it There are some instance where you might need to customise your client due to certain limitations.

The Client trait has a general constructor method and you should use the reqwest re-export to build you own customised client from the ground up.

Fields

api_key: String

client: T

base_url: String

Trait Implementations

impl BusRequests<LTAClient<Agent>> for Bus

fn get_arrival<'a>( client: &LTAClient<Agent>, bus_stop_code: u32, service_no: impl Into<Option<&'a str>> ) -> LTAResult<BusArrivalResp>

Returns real-time Bus Arrival information of Bus Services at a queried Bus Stop, including

fn get_bus_services( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<BusService>>

Returns detailed service information for all buses currently in operation, including: first stop, last stop, peak / offpeak frequency of dispatch.

fn get_bus_routes( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<BusRoute>>

Returns detailed route information for all services currently in operation, including: all bus stops along each route, first/last bus timings for each stop

fn get_bus_stops( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<BusStop>>

Returns detailed information for all bus stops currently being serviced by buses, including: Bus Stop Code, location coordinates.

impl BusRequests<LTAClient<Client>> for Bus

fn get_arrival<'a>( client: &LTAClient<ReqwestBlocking>, bus_stop_code: u32, service_no: impl Into<Option<&'a str>> ) -> LTAResult<BusArrivalResp>

Returns real-time Bus Arrival information of Bus Services at a queried Bus Stop, including

fn get_bus_services( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<BusService>>

Returns detailed service information for all buses currently in operation, including: first stop, last stop, peak / offpeak frequency of dispatch.

fn get_bus_routes( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<BusRoute>>

Returns detailed route information for all services currently in operation, including: all bus stops along each route, first/last bus timings for each stop

fn get_bus_stops( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<BusStop>>

Returns detailed information for all bus stops currently being serviced by buses, including: Bus Stop Code, location coordinates.

impl Client for LTAClient<Agent>

type InternalClient = Agent

Any backend Client

type RB = Request

Any type that can build requests

fn new( api_key: impl Into<String>, client: Self::InternalClient, base_url: impl Into<String> ) -> Self

General constructor for Self

fn with_api_key( api_key: impl Into<String>, base_url: impl Into<String> ) -> LTAResult<Self>

This method not assign the api_key in struct if the provided key is empty or whitespaces Instead, assign None

fn req_builder(&self, url: &str) -> Self::RB

Returns Self::RB

fn base_url(&self) -> &str

Returns the base URL that is set by user

impl Client for LTAClient<Client>

type InternalClient = Client

Any backend Client

type RB = RequestBuilder

Any type that can build requests

fn new( api_key: impl Into<String>, client: Self::InternalClient, base_url: impl Into<String> ) -> Self

General constructor for Self

fn with_api_key( api_key: impl Into<String>, base_url: impl Into<String> ) -> LTAResult<Self>

This method not assign the api_key in struct if the provided key is empty or whitespaces Instead, assign None

fn req_builder(&self, url: &str) -> Self::RB

Returns Self::RB

fn base_url(&self) -> &str

Returns the base URL that is set by user

impl ClientExt for LTAClient<Agent>

fn build_req_with_skip<T, T2>( &self, url: &str, skip: Option<u32> ) -> LTAResult<T2>

where for<'de> T: Deserialize<'de> + Into<T2>,

fn build_req_with_query<T, T2, F>(&self, url: &str, query: F) -> LTAResult<T2>

where F: FnOnce(Self::RB) -> Self::RB, for<'de> T: Deserialize<'de> + Into<T2>,

impl ClientExt for LTAClient<ReqwestBlocking>

fn build_req_with_skip<T, T2>( &self, url: &str, skip: Option<u32> ) -> LTAResult<T2>

where for<'de> T: Deserialize<'de> + Into<T2>,

fn build_req_with_query<T, T2, F>(&self, url: &str, query: F) -> LTAResult<T2>

where F: FnOnce(Self::RB) -> Self::RB, for<'de> T: Deserialize<'de> + Into<T2>,

impl<T: Clone> Clone for LTAClient<T>

fn clone(&self) -> LTAClient<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CrowdRequests<LTAClient<Agent>> for Crowd

fn get_passenger_vol_by( client: &LTAClient<Agent>, vol_type: VolType, date: impl Into<Option<Date>>, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<String>>

Creates a new client for every call Update freq: By 15th of every month, the passenger volume for previous month data will be generated

fn get_crowd_density_rt( client: &LTAClient<Agent>, train_line: MrtLine ) -> LTAResult<Vec<StationCrowdLevel>>

Returns real-time platform crowdedness level for the MRT/LRT stations of a particular train network line

fn get_crowd_density_forecast( client: &LTAClient<Agent>, train_line: MrtLine ) -> LTAResult<CrowdDensityForecast>

Returns forecasted platform crowdedness level for the MRT/LRT stations of a particular train network line at 30 minutes interval

impl CrowdRequests<LTAClient<Client>> for Crowd

fn get_passenger_vol_by( client: &LTAClient<ReqwestBlocking>, vol_type: VolType, date: impl Into<Option<Date>>, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<String>>

Creates a new client for every call Update freq: By 15th of every month, the passenger volume for previous month data will be generated

fn get_crowd_density_rt( client: &LTAClient<ReqwestBlocking>, train_line: MrtLine ) -> LTAResult<Vec<StationCrowdLevel>>

Returns real-time platform crowdedness level for the MRT/LRT stations of a particular train network line

fn get_crowd_density_forecast( client: &LTAClient<ReqwestBlocking>, train_line: MrtLine ) -> LTAResult<CrowdDensityForecast>

Returns forecasted platform crowdedness level for the MRT/LRT stations of a particular train network line at 30 minutes interval

impl<T: Debug> Debug for LTAClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FacilityRequests<LTAClient<Agent>> for Facility

fn get_facilities_maintenance( client: &LTAClient<Agent>, station_code: StationCode ) -> LTAResult<Vec<String>>

Returns pre-signed links to JSON file containing facilities maintenance schedules of the particular station

impl FacilityRequests<LTAClient<Client>> for Facility

fn get_facilities_maintenance( client: &LTAClient<ReqwestBlocking>, station_code: StationCode ) -> LTAResult<Vec<String>>

Returns pre-signed links to JSON file containing facilities maintenance schedules of the particular station

impl GeoRequests<LTAClient<Agent>> for Geo

fn get_geospatial_whole_island( client: &LTAClient<Agent>, id: GeospatialLayerId ) -> LTAResult<Vec<String>>

Returns the SHP files of the requested geospatial layer

impl GeoRequests<LTAClient<Client>> for Geo

fn get_geospatial_whole_island( client: &LTAClient<ReqwestBlocking>, id: GeospatialLayerId ) -> LTAResult<Vec<String>>

Returns the SHP files of the requested geospatial layer

impl TaxiRequests<LTAClient<Agent>> for Taxi

fn get_taxi_avail( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<Coordinates>>

Returns location coordinates of all Taxis that are currently available for hire. Does not include “Hired” or “Busy” Taxis.

fn get_taxi_stands( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<TaxiStand>>

Returns detailed information of Taxi stands, such as location and whether is it barrier free.

impl TaxiRequests<LTAClient<Client>> for Taxi

fn get_taxi_avail( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<Coordinates>>

Returns location coordinates of all Taxis that are currently available for hire. Does not include “Hired” or “Busy” Taxis.

fn get_taxi_stands( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<TaxiStand>>

Returns detailed information of Taxi stands, such as location and whether is it barrier free.

impl TrafficRequests<LTAClient<Agent>> for Traffic

fn get_bike_parking( client: &LTAClient<Agent>, lat: f64, long: f64, dist: impl Into<Option<f64>> ) -> LTAResult<Vec<BikeParking>>

Returns bicycle parking locations within a radius

fn get_erp_rates( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<ErpRate>>

Returns ERP rates of all vehicle types across all timings for each zone.

fn get_carpark_avail( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<CarPark>>

Returns no. of available lots for HDB, LTA and URA carpark data. The LTA carpark data consist of major shopping malls and developments within Orchard, Marina, HarbourFront, Jurong Lake District. (Note: list of LTA carpark data available on this API is subset of those listed on One.Motoring and MyTransport Portals)

fn get_est_travel_time( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<EstTravelTime>>

Returns estimated travel times of expressways (in segments).

fn get_faulty_traffic_lights( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<FaultyTrafficLight>>

Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance.

fn get_road_details( client: &C, road_details_type: RoadDetailsType, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<RoadDetails>>

Returns all planned road openings or road works depending on the RoadDetailsType supplied

fn get_traffic_speed_band( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<TrafficSpeedBand>>

Returns current traffic speeds on expressways and arterial roads, expressed in speed bands.

fn get_traffic_images( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<TrafficImage>>

Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints.

fn get_traffic_incidents( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<TrafficIncident>>

Returns current traffic speeds on expressways and arterial roads, expressed in speed bands.

fn get_vms_emas(client: &C, skip: impl Into<Option<u32>>) -> LTAResult<Vec<Vms>>

Returns traffic advisories (via variable message services) concerning current traffic conditions that are displayed on EMAS signboards along expressways and arterial roads.

fn get_traffic_flow(client: &C) -> LTAResult<Vec<String>>

Returns hourly average traffic flow, taken from a representative month of every quarter during 0700-0900 hours.

impl TrafficRequests<LTAClient<Client>> for Traffic

fn get_bike_parking( client: &LTAClient<ReqwestBlocking>, lat: f64, long: f64, dist: impl Into<Option<f64>> ) -> LTAResult<Vec<BikeParking>>

Returns bicycle parking locations within a radius

fn get_erp_rates( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<ErpRate>>

Returns ERP rates of all vehicle types across all timings for each zone.

fn get_carpark_avail( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<CarPark>>

Returns no. of available lots for HDB, LTA and URA carpark data. The LTA carpark data consist of major shopping malls and developments within Orchard, Marina, HarbourFront, Jurong Lake District. (Note: list of LTA carpark data available on this API is subset of those listed on One.Motoring and MyTransport Portals)

fn get_est_travel_time( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<EstTravelTime>>

Returns estimated travel times of expressways (in segments).

fn get_faulty_traffic_lights( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<FaultyTrafficLight>>

Returns alerts of traffic lights that are currently faulty, or currently undergoing scheduled maintenance.

fn get_road_details( client: &C, road_details_type: RoadDetailsType, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<RoadDetails>>

Returns all planned road openings or road works depending on the RoadDetailsType supplied

fn get_traffic_speed_band( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<TrafficSpeedBand>>

Returns current traffic speeds on expressways and arterial roads, expressed in speed bands.

fn get_traffic_images( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<TrafficImage>>

Returns links to images of live traffic conditions along expressways and Woodlands & Tuas Checkpoints.

fn get_traffic_incidents( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<Vec<TrafficIncident>>

Returns current traffic speeds on expressways and arterial roads, expressed in speed bands.

fn get_vms_emas(client: &C, skip: impl Into<Option<u32>>) -> LTAResult<Vec<Vms>>

Returns traffic advisories (via variable message services) concerning current traffic conditions that are displayed on EMAS signboards along expressways and arterial roads.

fn get_traffic_flow(client: &C) -> LTAResult<Vec<String>>

Returns hourly average traffic flow, taken from a representative month of every quarter during 0700-0900 hours.

impl TrainRequests<LTAClient<Agent>> for Train

fn get_train_service_alert( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<TrainServiceAlert>

Returns detailed information on train service unavailability during scheduled operating hours, such as affected line and stations etc.

impl TrainRequests<LTAClient<Client>> for Train

fn get_train_service_alert( client: &C, skip: impl Into<Option<u32>> ) -> LTAResult<TrainServiceAlert>

Returns detailed information on train service unavailability during scheduled operating hours, such as affected line and stations etc.