Skip to main content

TardisDataClientConfigBuilder

nautilus_tardis::config

Struct TardisDataClientConfigBuilder 

Source 
pub struct TardisDataClientConfigBuilder<S: State = Empty> { /* private fields */ }
Expand description

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

Implementations§

Source§

impl<S: State> TardisDataClientConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

pub fn api_key( self, value: String, ) -> TardisDataClientConfigBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

Optional (Some / Option setters). Tardis API key for HTTP instrument fetching. Falls back to TARDIS_API_KEY env var if not set.

Source

pub fn maybe_api_key( self, value: Option<String>, ) -> TardisDataClientConfigBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

Optional (Some / Option setters). Tardis API key for HTTP instrument fetching. Falls back to TARDIS_API_KEY env var if not set.

Source

pub fn tardis_ws_url( self, value: String, ) -> TardisDataClientConfigBuilder<SetTardisWsUrl<S>>
where S::TardisWsUrl: IsUnset,

Optional (Some / Option setters). Tardis Machine Server WebSocket URL. Falls back to TARDIS_MACHINE_WS_URL env var if not set.

Source

pub fn maybe_tardis_ws_url( self, value: Option<String>, ) -> TardisDataClientConfigBuilder<SetTardisWsUrl<S>>
where S::TardisWsUrl: IsUnset,

Optional (Some / Option setters). Tardis Machine Server WebSocket URL. Falls back to TARDIS_MACHINE_WS_URL env var if not set.

Source

pub fn proxy_url( self, value: String, ) -> TardisDataClientConfigBuilder<SetProxyUrl<S>>
where S::ProxyUrl: IsUnset,

Optional (Some / Option setters). Optional proxy URL for the Tardis HTTP API client. The Tardis Machine WebSocket transport does not yet support proxying.

Source

pub fn maybe_proxy_url( self, value: Option<String>, ) -> TardisDataClientConfigBuilder<SetProxyUrl<S>>
where S::ProxyUrl: IsUnset,

Optional (Some / Option setters). Optional proxy URL for the Tardis HTTP API client. The Tardis Machine WebSocket transport does not yet support proxying.

Source

pub fn normalize_symbols( self, value: bool, ) -> TardisDataClientConfigBuilder<SetNormalizeSymbols<S>>
where S::NormalizeSymbols: IsUnset,

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

Whether to normalize symbols to Nautilus conventions.

Source

pub fn maybe_normalize_symbols( self, value: Option<bool>, ) -> TardisDataClientConfigBuilder<SetNormalizeSymbols<S>>
where S::NormalizeSymbols: IsUnset,

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

Whether to normalize symbols to Nautilus conventions.

Source

pub fn book_snapshot_output( self, value: BookSnapshotOutput, ) -> TardisDataClientConfigBuilder<SetBookSnapshotOutput<S>>
where S::BookSnapshotOutput: IsUnset,

Optional (Some / Option setters). Default: <BookSnapshotOutput as Default>::default().

Output format for book_snapshot_* messages.

Source

pub fn maybe_book_snapshot_output( self, value: Option<BookSnapshotOutput>, ) -> TardisDataClientConfigBuilder<SetBookSnapshotOutput<S>>
where S::BookSnapshotOutput: IsUnset,

Optional (Some / Option setters). Default: <BookSnapshotOutput as Default>::default().

Output format for book_snapshot_* messages.

Source

pub fn options( self, value: Vec<ReplayNormalizedRequestOptions>, ) -> TardisDataClientConfigBuilder<SetOptions<S>>
where S::Options: IsUnset,

Optional (Some / Option setters). Default: <Vec<ReplayNormalizedRequestOptions> as Default>::default().

Replay options defining exchanges, symbols, date ranges, and data types. When non-empty the client connects to ws-replay-normalized.

Source

pub fn maybe_options( self, value: Option<Vec<ReplayNormalizedRequestOptions>>, ) -> TardisDataClientConfigBuilder<SetOptions<S>>
where S::Options: IsUnset,

Optional (Some / Option setters). Default: <Vec<ReplayNormalizedRequestOptions> as Default>::default().

Replay options defining exchanges, symbols, date ranges, and data types. When non-empty the client connects to ws-replay-normalized.

Source

pub fn stream_options( self, value: Vec<StreamNormalizedRequestOptions>, ) -> TardisDataClientConfigBuilder<SetStreamOptions<S>>
where S::StreamOptions: IsUnset,

Optional (Some / Option setters). Default: <Vec<StreamNormalizedRequestOptions> as Default>::default().

Live stream options defining exchanges, symbols, and data types. When non-empty (and options is empty) the client connects to ws-stream-normalized with automatic reconnection.

Source

pub fn maybe_stream_options( self, value: Option<Vec<StreamNormalizedRequestOptions>>, ) -> TardisDataClientConfigBuilder<SetStreamOptions<S>>
where S::StreamOptions: IsUnset,

Optional (Some / Option setters). Default: <Vec<StreamNormalizedRequestOptions> as Default>::default().

Live stream options defining exchanges, symbols, and data types. When non-empty (and options is empty) the client connects to ws-stream-normalized with automatic reconnection.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
§

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

§

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
§

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, 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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

§

impl<T> Ungil for T
where T: Send,