Struct databento::historical::Client
source · pub struct Client { /* private fields */ }
Available on crate feature
historical
only.Expand description
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:
Implementations§
source§impl Client
impl Client
sourcepub fn builder() -> ClientBuilder<Unset>
pub fn builder() -> ClientBuilder<Unset>
Returns a type-safe builder for setting the required parameters
for initializing a HistoricalClient
.
sourcepub fn new(key: String, gateway: HistoricalGateway) -> Result<Self>
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.
sourcepub fn gateway(&self) -> HistoricalGateway
pub fn gateway(&self) -> HistoricalGateway
Returns the configured Historical gateway.
sourcepub fn batch(&mut self) -> BatchClient<'_>
pub fn batch(&mut self) -> BatchClient<'_>
Returns the batch subclient.
sourcepub fn metadata(&mut self) -> MetadataClient<'_>
pub fn metadata(&mut self) -> MetadataClient<'_>
Returns the metadata subclient.
sourcepub fn symbology(&mut self) -> SymbologyClient<'_>
pub fn symbology(&mut self) -> SymbologyClient<'_>
Returns the symbology subclient.
sourcepub fn timeseries(&mut self) -> TimeseriesClient<'_>
pub fn timeseries(&mut self) -> TimeseriesClient<'_>
Returns the timeseries subclient.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
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