pub struct DatabentoLive<K> { /* private fields */ }Expand description
Live streaming client for Databento.
Wraps LiveClient for real-time market data streaming. Each instance connects
to a single dataset but can subscribe to multiple symbols within that dataset.
§Connection Limits
- Standard tier: 10 concurrent connections per dataset
- Enterprise tier: 50 concurrent connections per dataset
Consolidate symbol subscriptions within one DatabentoLive instance per dataset
rather than creating multiple instances for the same dataset.
§Performance
The instrument key is cloned for each record. For high-frequency data, use
Arc<K> to avoid per-record heap allocations:
use std::sync::Arc;
let instruments: HashMap<String, Arc<String>> = [
("ESM5".to_string(), Arc::new("ES-front".to_string())),
].into_iter().collect();Implementations§
Source§impl<K> DatabentoLive<K>
impl<K> DatabentoLive<K>
Sourcepub async fn from_env(
dataset: &str,
exchange: ExchangeId,
instruments: HashMap<String, K>,
) -> Result<Self, DataError>
pub async fn from_env( dataset: &str, exchange: ExchangeId, instruments: HashMap<String, K>, ) -> Result<Self, DataError>
Create a new live client using API key from environment.
Reads DATABENTO_API_KEY from environment variables.
§Arguments
dataset- Databento dataset identifier (e.g., “GLBX.MDP3”, “XNAS.ITCH”)exchange- ExchangeId to tag events with (should match dataset)instruments- Map from Databento symbol strings to user’s instrument keys
§Errors
Returns error if DATABENTO_API_KEY is not set or client construction fails.
Sourcepub async fn new(
api_key: &str,
dataset: &str,
exchange: ExchangeId,
instruments: HashMap<String, K>,
) -> Result<Self, DataError>
pub async fn new( api_key: &str, dataset: &str, exchange: ExchangeId, instruments: HashMap<String, K>, ) -> Result<Self, DataError>
Create a new live client with an explicit API key.
§Errors
Returns error if client construction fails.
Sourcepub async fn subscribe(
&mut self,
symbols: &[&str],
schema: Schema,
) -> Result<(), DataError>
pub async fn subscribe( &mut self, symbols: &[&str], schema: Schema, ) -> Result<(), DataError>
Subscribe to symbols with a specific schema.
Can be called multiple times before start() to add more subscriptions.
All subscriptions are multiplexed over the same connection.
§Arguments
symbols- Symbol identifiers (e.g.,["ESM5", "NQM5"])schema- Data schema to subscribe to (e.g.,Schema::Trades,Schema::Mbp1)
§OHLCV note
This is the low-level escape hatch: it subscribes to any Schema as-is and
performs no interval validation. Subscribing to an OHLCV schema here
(e.g. Schema::Ohlcv1H/Schema::Ohlcv1D) bypasses the Sec1/Min1
live-only check in subscribe_candles, and any
resulting bars whose rtype maps to a CandleInterval will be emitted as
DataKind::Candle. Prefer subscribe_candles for
candles unless you deliberately want that lower-level behaviour.
§Errors
Returns error if subscription request fails.
Sourcepub async fn subscribe_candles(
&mut self,
symbols: &[&str],
interval: CandleInterval,
) -> Result<(), DataError>
pub async fn subscribe_candles( &mut self, symbols: &[&str], interval: CandleInterval, ) -> Result<(), DataError>
Subscribe to OHLCV candles for symbols at the given interval.
Validates the interval and maps it to the Databento OHLCV schema before
subscribing. The resulting stream emits DataKind::Candle events whose
interval is derived per-record from each bar’s rtype, so a single
connection may safely carry multiple OHLCV intervals.
§Live interval scope
Only Sec1/Min1 are accepted live. Databento’s live gateway does not
reliably stream the larger Hour1/Day1 bars, so those are
historical-only here — use DatabentoHistorical::fetch_candles.
They are rejected at subscribe time (observable failure) rather than
yielding a silently empty stream.
§Errors
Returns DataError::UnsupportedInterval for any interval other than
Sec1/Min1, or DataError::Databento if the subscription request fails.
Sourcepub fn client(&self) -> &LiveClient
pub fn client(&self) -> &LiveClient
Returns a reference to the underlying client for advanced use cases.
Sourcepub fn client_mut(&mut self) -> &mut LiveClient
pub fn client_mut(&mut self) -> &mut LiveClient
Returns a mutable reference to the underlying client.
Source§impl<K: Clone + Send + 'static> DatabentoLive<K>
impl<K: Clone + Send + 'static> DatabentoLive<K>
Sourcepub async fn start(
self,
) -> Result<impl Stream<Item = Result<MarketEvent<K, DataKind>, DataError>>, DataError>
pub async fn start( self, ) -> Result<impl Stream<Item = Result<MarketEvent<K, DataKind>, DataError>>, DataError>
Start streaming and return an owned stream of market events.
Consumes self because LiveClient requires mutable access for polling.
The stream will emit events until the connection closes or an error occurs.
§Returns
A stream of MarketEvent<K, DataKind> where DataKind is one of Trade,
OrderBookL1, or Candle depending on the subscribed schema(s).
Records for symbols not in the instruments map are skipped with a warning.
§Errors
Returns error if starting the stream fails. Stream items may also contain errors for individual record processing failures.
Trait Implementations§
Auto Trait Implementations§
impl<K> !RefUnwindSafe for DatabentoLive<K>
impl<K> !UnwindSafe for DatabentoLive<K>
impl<K> Freeze for DatabentoLive<K>
impl<K> Send for DatabentoLive<K>
impl<K> Sync for DatabentoLive<K>
impl<K> Unpin for DatabentoLive<K>
impl<K> UnsafeUnpin for DatabentoLive<K>
Blanket Implementations§
Source§impl<T> AttachedTransformer<()> for T
impl<T> AttachedTransformer<()> for T
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
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreimpl<T> JsonSchemaMaybe for T
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.