Skip to main content

DatabentoLiveClient

Struct DatabentoLiveClient 

Source
pub struct DatabentoLiveClient {
    pub dataset: String,
    /* private fields */
}

Fields§

§dataset: String

Implementations§

Source§

impl DatabentoLiveClient

Source

pub fn new( key: String, dataset: String, publishers_filepath: PathBuf, use_exchange_as_venue: bool, bars_timestamp_on_close: Option<bool>, reconnect_timeout_mins: Option<i64>, ) -> Result<Self>

Creates a new DatabentoLiveClient instance.

§Errors

Returns an error if reading or parsing the publishers file fails.

Source

pub const fn is_running(&self) -> bool

Source

pub const fn is_closed(&self) -> bool

Source

pub fn subscribe( &mut self, schema: String, instrument_ids: Vec<InstrumentId>, start: Option<u64>, snapshot: Option<bool>, price_precisions: Option<Vec<Option<u8>>>, stype_in: Option<String>, ) -> Result<()>

Subscribes to Databento live data for the requested instruments.

§Errors

Returns an error if symbology, schema, timestamp, or precision inputs are invalid, or if the command cannot be sent to the feed handler.

Source

pub fn start( &mut self, ) -> Result<(DatabentoFeedHandler, UnboundedReceiver<DatabentoMessage>)>

Starts the live feed handler and returns its message receiver.

§Errors

Returns an error if the client is already closed, already running, or cannot start.

Source

pub fn close(&mut self) -> Result<()>

Closes the live client.

§Errors

Returns an error if the client was never started, is already closed, or cannot send the close command to the feed handler.

Trait Implementations§

Source§

impl Debug for DatabentoLiveClient

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more