Struct databento::live::ClientBuilder

pub struct ClientBuilder<AK, D> { /* private fields */ }

Available on crate feature live only.

A type-safe builder for the LiveClient. It will not allow you to call Self::build() before setting the required fields:

• key
• dataset

Implementations

impl<AK, D> ClientBuilder<AK, D>

pub fn send_ts_out(self, send_ts_out: bool) -> Self

Sets ts_out, which when enabled instructs the gateway to send a send timestamp after every record. These can be decoded with the special WithTsOut type.

pub fn upgrade_policy(self, upgrade_policy: VersionUpgradePolicy) -> Self

Sets upgrade_policy, which controls how to decode data from prior DBN versions. The current default is to upgrade them to the latest version while decoding.

pub fn heartbeat_interval(self, heartbeat_interval: Duration) -> Self

Sets heartbeat_interval, which controls the interval at which the gateway will send heartbeat records if no other data records are sent. If no heartbeat interval is configured, the gateway default will be used.

Note that granularity of less than a second is not supported and will be ignored.

pub async fn addr(self, addr: impl ToSocketAddrs) -> Result<Self>

Overrides the address of the gateway the client will connect to. This is an advanced method.

Errors

This function returns an error when addr fails to resolve.

impl ClientBuilder<Unset, Unset>

pub fn new() -> Self

Creates a new ClientBuilder.

impl<D> ClientBuilder<Unset, D>

pub fn key(self, key: impl ToString) -> Result<ClientBuilder<ApiKey, D>>

Sets the API key.

Errors

This function returns an error when the API key is invalid.

pub fn key_from_env(self) -> Result<ClientBuilder<ApiKey, D>>

Sets the API key reading it from the DATABENTO_API_KEY environment variable.

Errors

This function returns an error when the environment variable is not set or the API key is invalid.

impl<AK> ClientBuilder<AK, Unset>

pub fn dataset(self, dataset: impl ToString) -> ClientBuilder<AK, String>

Sets the dataset.

impl ClientBuilder<ApiKey, String>

pub async fn build(self) -> Result<Client>

Initializes the client and attempts to connect to the gateway.

Errors

This function returns an error when its unable to connect and authenticate with the Live gateway.

Trait Implementations

impl<AK: Clone, D: Clone> Clone for ClientBuilder<AK, D>

fn clone(&self) -> ClientBuilder<AK, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<AK: Debug, D: Debug> Debug for ClientBuilder<AK, D>

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

Formats the value using the given formatter.