Skip to main content

BacktestDataConfigBuilder

nautilus_backtest::config

Struct BacktestDataConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> BacktestDataConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

pub fn data_type( self, value: NautilusDataType, ) -> BacktestDataConfigBuilder<SetDataType<S>>
where S::DataType: IsUnset,

Required.

The type of data to query from the catalog.

Source

pub fn catalog_path( self, value: String, ) -> BacktestDataConfigBuilder<SetCatalogPath<S>>
where S::CatalogPath: IsUnset,

Required.

The path to the data catalog.

Source

pub fn catalog_fs_protocol( self, value: String, ) -> BacktestDataConfigBuilder<SetCatalogFsProtocol<S>>
where S::CatalogFsProtocol: IsUnset,

Optional (Some / Option setters). The fsspec filesystem protocol for the catalog.

Source

pub fn maybe_catalog_fs_protocol( self, value: Option<String>, ) -> BacktestDataConfigBuilder<SetCatalogFsProtocol<S>>
where S::CatalogFsProtocol: IsUnset,

Optional (Some / Option setters). The fsspec filesystem protocol for the catalog.

Source

pub fn catalog_fs_storage_options( self, value: AHashMap<String, String>, ) -> BacktestDataConfigBuilder<SetCatalogFsStorageOptions<S>>
where S::CatalogFsStorageOptions: IsUnset,

Optional (Some / Option setters). The filesystem storage options for the catalog (e.g. cloud auth credentials).

Source

pub fn maybe_catalog_fs_storage_options( self, value: Option<AHashMap<String, String>>, ) -> BacktestDataConfigBuilder<SetCatalogFsStorageOptions<S>>
where S::CatalogFsStorageOptions: IsUnset,

Optional (Some / Option setters). The filesystem storage options for the catalog (e.g. cloud auth credentials).

Source

pub fn catalog_fs_rust_storage_options( self, value: AHashMap<String, String>, ) -> BacktestDataConfigBuilder<SetCatalogFsRustStorageOptions<S>>
where S::CatalogFsRustStorageOptions: IsUnset,

Optional (Some / Option setters). Rust-specific storage options for the catalog backend.

Source

pub fn maybe_catalog_fs_rust_storage_options( self, value: Option<AHashMap<String, String>>, ) -> BacktestDataConfigBuilder<SetCatalogFsRustStorageOptions<S>>
where S::CatalogFsRustStorageOptions: IsUnset,

Optional (Some / Option setters). Rust-specific storage options for the catalog backend.

Source

pub fn instrument_id( self, value: InstrumentId, ) -> BacktestDataConfigBuilder<SetInstrumentId<S>>
where S::InstrumentId: IsUnset,

Optional (Some / Option setters). The instrument ID for the data configuration (single).

Source

pub fn maybe_instrument_id( self, value: Option<InstrumentId>, ) -> BacktestDataConfigBuilder<SetInstrumentId<S>>
where S::InstrumentId: IsUnset,

Optional (Some / Option setters). The instrument ID for the data configuration (single).

Source

pub fn instrument_ids( self, value: Vec<InstrumentId>, ) -> BacktestDataConfigBuilder<SetInstrumentIds<S>>
where S::InstrumentIds: IsUnset,

Optional (Some / Option setters). Multiple instrument IDs for the data configuration.

Source

pub fn maybe_instrument_ids( self, value: Option<Vec<InstrumentId>>, ) -> BacktestDataConfigBuilder<SetInstrumentIds<S>>
where S::InstrumentIds: IsUnset,

Optional (Some / Option setters). Multiple instrument IDs for the data configuration.

Source

pub fn start_time( self, value: UnixNanos, ) -> BacktestDataConfigBuilder<SetStartTime<S>>
where S::StartTime: IsUnset,

Optional (Some / Option setters). The start time for the data configuration.

Source

pub fn maybe_start_time( self, value: Option<UnixNanos>, ) -> BacktestDataConfigBuilder<SetStartTime<S>>
where S::StartTime: IsUnset,

Optional (Some / Option setters). The start time for the data configuration.

Source

pub fn end_time( self, value: UnixNanos, ) -> BacktestDataConfigBuilder<SetEndTime<S>>
where S::EndTime: IsUnset,

Optional (Some / Option setters). The end time for the data configuration.

Source

pub fn maybe_end_time( self, value: Option<UnixNanos>, ) -> BacktestDataConfigBuilder<SetEndTime<S>>
where S::EndTime: IsUnset,

Optional (Some / Option setters). The end time for the data configuration.

Source

pub fn filter_expr( self, value: String, ) -> BacktestDataConfigBuilder<SetFilterExpr<S>>
where S::FilterExpr: IsUnset,

Optional (Some / Option setters). The additional filter expressions for the data catalog query.

Source

pub fn maybe_filter_expr( self, value: Option<String>, ) -> BacktestDataConfigBuilder<SetFilterExpr<S>>
where S::FilterExpr: IsUnset,

Optional (Some / Option setters). The additional filter expressions for the data catalog query.

Source

pub fn client_id( self, value: ClientId, ) -> BacktestDataConfigBuilder<SetClientId<S>>
where S::ClientId: IsUnset,

Optional (Some / Option setters). The client ID for the data configuration.

Source

pub fn maybe_client_id( self, value: Option<ClientId>, ) -> BacktestDataConfigBuilder<SetClientId<S>>
where S::ClientId: IsUnset,

Optional (Some / Option setters). The client ID for the data configuration.

Source

pub fn metadata( self, value: AHashMap<String, String>, ) -> BacktestDataConfigBuilder<SetMetadata<S>>
where S::Metadata: IsUnset,

Optional (Some / Option setters). The metadata for the data catalog query.

Source

pub fn maybe_metadata( self, value: Option<AHashMap<String, String>>, ) -> BacktestDataConfigBuilder<SetMetadata<S>>
where S::Metadata: IsUnset,

Optional (Some / Option setters). The metadata for the data catalog query.

Source

pub fn bar_spec( self, value: BarSpecification, ) -> BacktestDataConfigBuilder<SetBarSpec<S>>
where S::BarSpec: IsUnset,

Optional (Some / Option setters). The bar specification for the data catalog query.

Source

pub fn maybe_bar_spec( self, value: Option<BarSpecification>, ) -> BacktestDataConfigBuilder<SetBarSpec<S>>
where S::BarSpec: IsUnset,

Optional (Some / Option setters). The bar specification for the data catalog query.

Source

pub fn bar_types( self, value: Vec<String>, ) -> BacktestDataConfigBuilder<SetBarTypes<S>>
where S::BarTypes: IsUnset,

Optional (Some / Option setters). Explicit bar type strings for the data catalog query (e.g. “EUR/USD.SIM-1-MINUTE-LAST-EXTERNAL”).

Source

pub fn maybe_bar_types( self, value: Option<Vec<String>>, ) -> BacktestDataConfigBuilder<SetBarTypes<S>>
where S::BarTypes: IsUnset,

Optional (Some / Option setters). Explicit bar type strings for the data catalog query (e.g. “EUR/USD.SIM-1-MINUTE-LAST-EXTERNAL”).

Source

pub fn optimize_file_loading( self, value: bool, ) -> BacktestDataConfigBuilder<SetOptimizeFileLoading<S>>
where S::OptimizeFileLoading: IsUnset,

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

If directory-based file registration should be used for more efficient loading.

Source

pub fn maybe_optimize_file_loading( self, value: Option<bool>, ) -> BacktestDataConfigBuilder<SetOptimizeFileLoading<S>>
where S::OptimizeFileLoading: IsUnset,

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

If directory-based file registration should be used for more efficient loading.

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,