Struct CachedClient

pub struct CachedClient<T>
where
    T: QueueTimesClient + Send + Sync + 'static,
{ /* private fields */ }

Thread-safe cache wrapper for a QueueTimesClient.

Details

The cached client will only hit the API every five minutes, as that is the rate that the queue times website updates wait times. This means that this client is far more efficient if large numbers of requests are made to the API, such as when being used in a server. The internal state and thread-safe nature do however add considerable overhead in scenarios where only occasional calls are made, so a choice must be made depending on your use case.

The implimentation will eagerly return results, but lazaly updates cache. This means that if the client is never called, then it will never update the cache. But if it does need to update the cache, it will first return the result of the request, while the cache updates in the background.

Example

use queue_times::client::{Client, QueueTimesClient, CachedClient};

let client = Client::new();
let client = CachedClient::new(client); //The only added line!
let parks = client.get_park_urls().await?;
let cedar_point_waits = client.get_ride_times(parks.get("Cedar Point")?.to_owned()).await?;

let mille_wait = cedar_point_waits.iter().find(|r| r.name == "Millennium Force").unwrap();

println!("The current wait for Millennium Force is: {:?}", mille_wait.status)

Implementations

impl<T> CachedClient<T>

where T: QueueTimesClient + Send + Sync + 'static,

pub fn new(client: T) -> Self

Wraps the passed client with a cache.

Trait Implementations

impl Default for CachedClient<Client>

fn default() -> Self

Returns the “default value” for a type.

impl<T> QueueTimesClient for CachedClient<T>

where T: QueueTimesClient + Send + Sync + 'static,

fn get_park_urls<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<HashMap<String, Url>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves a map of park names to the url of their rides page.

fn get_ride_times<'life0, 'async_trait>( &'life0 self, park_url: Url, ) -> Pin<Box<dyn Future<Output = Result<Vec<RideTime>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves the queue times for all parsable rides on a park rides page.