Struct Client

pub struct Client { /* private fields */ }

Available on crate feature historical only.

The Historical client. Used for symbology resolutions, metadata requests, Historical data older than 24 hours, and submitting batch downloads.

Use HistoricalClient::builder() to get a type-safe builder for initializing the required parameters for the client.

individual API methods are accessed through its four subclients:

• metadata()
• timeseries()
• symbology()
• batch()

Implementations

impl Client

pub fn builder() -> ClientBuilder<Unset>

Returns a type-safe builder for setting the required parameters for initializing a HistoricalClient.

pub fn new(key: String, gateway: HistoricalGateway) -> Result<Self>

Creates a new client with the given API key.

Errors

This function returns an error when it fails to build the HTTP client.

pub fn with_url( url: impl IntoUrl, key: String, gateway: HistoricalGateway, ) -> Result<Self>

👎Deprecated since 0.28.0: Use the builder instead

Creates a new client with a specific API URL. This is an advanced method and builder() or new() should be used instead.

Errors

This function returns an error when the url is invalid.

pub fn key(&self) -> &str

Returns the API key used by the instance of the client.

pub fn gateway(&self) -> HistoricalGateway

Returns the configured Historical gateway.

pub fn batch(&mut self) -> BatchClient<'_>

Returns the batch subclient.

pub fn metadata(&mut self) -> MetadataClient<'_>

Returns the metadata subclient.

pub fn symbology(&mut self) -> SymbologyClient<'_>

Returns the symbology subclient.

pub fn timeseries(&mut self) -> TimeseriesClient<'_>

Returns the timeseries subclient.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.