Skip to main content

SubscriptionBuilder

databento::live

Struct SubscriptionBuilder 

Source 
pub struct SubscriptionBuilder<S: State = Empty> { /* private fields */ }
Available on crate feature live only.
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> SubscriptionBuilder<S>

Source

pub fn build(self) -> Subscription
where S: IsComplete,

Finish building and return the requested object

Source

pub fn symbols( self, value: impl Into<Symbols>, ) -> SubscriptionBuilder<SetSymbols<S>>
where S::Symbols: IsUnset,

Required.

The symbols of the instruments to subscribe to.

Source

pub fn schema(self, value: Schema) -> SubscriptionBuilder<SetSchema<S>>
where S::Schema: IsUnset,

Required.

The data record schema of data to subscribe to.

Source

pub fn stype_in(self, value: SType) -> SubscriptionBuilder<SetStypeIn<S>>
where S::StypeIn: IsUnset,

Optional (Some / Option setters). Default: SType::RawSymbol.

The symbology type of the symbols in symbols.

Source

pub fn maybe_stype_in( self, value: Option<SType>, ) -> SubscriptionBuilder<SetStypeIn<S>>
where S::StypeIn: IsUnset,

Optional (Some / Option setters). Default: SType::RawSymbol.

The symbology type of the symbols in symbols.

Source

pub fn start(self, dt: impl DateTimeLike) -> SubscriptionBuilder<SetStart<S>>
where S::Start: IsUnset,

Optional (Some / Option setters). The inclusive start of subscription replay. Pass OffsetDateTime::UNIX_EPOCH to request all available data. When None, only real-time data is sent.

Cannot be specified after the session is started with LiveClient::start. See Intraday Replay.

Source

pub fn maybe_start( self, value: Option<impl DateTimeLike>, ) -> SubscriptionBuilder<SetStart<S>>
where S::Start: IsUnset,

Optional (Some / Option setters). The inclusive start of subscription replay. Pass OffsetDateTime::UNIX_EPOCH to request all available data. When None, only real-time data is sent.

Cannot be specified after the session is started with LiveClient::start. See Intraday Replay.

Source

pub fn use_snapshot(self, value: bool) -> SubscriptionBuilder<SetUseSnapshot<S>>
where S::UseSnapshot: IsUnset,

Optional (Some / Option setters). Default: false.

Request subscription with snapshot. Only supported with Mbo schema. Defaults to false. Conflicts with the start parameter.

Source

pub fn maybe_use_snapshot( self, value: Option<bool>, ) -> SubscriptionBuilder<SetUseSnapshot<S>>
where S::UseSnapshot: IsUnset,

Optional (Some / Option setters). Default: false.

Request subscription with snapshot. Only supported with Mbo schema. Defaults to false. Conflicts with the start parameter.

Source

pub fn id(self, value: u32) -> SubscriptionBuilder<SetId<S>>
where S::Id: IsUnset,

Optional (Some / Option setters). The optional numerical identifier associated with this subscription.

Source

pub fn maybe_id(self, value: Option<u32>) -> SubscriptionBuilder<SetId<S>>
where S::Id: IsUnset,

Optional (Some / Option setters). The optional numerical identifier associated with this subscription.

Trait Implementations§

Source§

impl<S: State> Clone for SubscriptionBuilder<S>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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: 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: 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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