Skip to main content

BacktestRunConfigBuilder

nautilus_backtest::config

Struct BacktestRunConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> BacktestRunConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

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

Optional (Some / Option setters). Default: UUID4::new().to_string().

The unique identifier for this run configuration.

Source

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

Optional (Some / Option setters). Default: UUID4::new().to_string().

The unique identifier for this run configuration.

Source

pub fn venues( self, value: Vec<BacktestVenueConfig>, ) -> BacktestRunConfigBuilder<SetVenues<S>>
where S::Venues: IsUnset,

Required.

The venue configurations for the backtest run.

Source

pub fn data( self, value: Vec<BacktestDataConfig>, ) -> BacktestRunConfigBuilder<SetData<S>>
where S::Data: IsUnset,

Required.

The data configurations for the backtest run.

Source

pub fn engine( self, value: BacktestEngineConfig, ) -> BacktestRunConfigBuilder<SetEngine<S>>
where S::Engine: IsUnset,

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

The backtest engine configuration (the core system kernel).

Source

pub fn maybe_engine( self, value: Option<BacktestEngineConfig>, ) -> BacktestRunConfigBuilder<SetEngine<S>>
where S::Engine: IsUnset,

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

The backtest engine configuration (the core system kernel).

Source

pub fn chunk_size( self, value: usize, ) -> BacktestRunConfigBuilder<SetChunkSize<S>>
where S::ChunkSize: IsUnset,

Optional (Some / Option setters). The number of data points to process in each chunk during streaming mode. If None, the backtest will run without streaming, loading all data at once.

Source

pub fn maybe_chunk_size( self, value: Option<usize>, ) -> BacktestRunConfigBuilder<SetChunkSize<S>>
where S::ChunkSize: IsUnset,

Optional (Some / Option setters). The number of data points to process in each chunk during streaming mode. If None, the backtest will run without streaming, loading all data at once.

Source

pub fn raise_exception( self, value: bool, ) -> BacktestRunConfigBuilder<SetRaiseException<S>>
where S::RaiseException: IsUnset,

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

If exceptions during build or run should interrupt processing.

Source

pub fn maybe_raise_exception( self, value: Option<bool>, ) -> BacktestRunConfigBuilder<SetRaiseException<S>>
where S::RaiseException: IsUnset,

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

If exceptions during build or run should interrupt processing.

Source

pub fn dispose_on_completion( self, value: bool, ) -> BacktestRunConfigBuilder<SetDisposeOnCompletion<S>>
where S::DisposeOnCompletion: IsUnset,

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

If the backtest engine should be disposed on completion of the run. If True, then will drop data and all state. If False, then will only drop data.

Source

pub fn maybe_dispose_on_completion( self, value: Option<bool>, ) -> BacktestRunConfigBuilder<SetDisposeOnCompletion<S>>
where S::DisposeOnCompletion: IsUnset,

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

If the backtest engine should be disposed on completion of the run. If True, then will drop data and all state. If False, then will only drop data.

Source

pub fn start(self, value: UnixNanos) -> BacktestRunConfigBuilder<SetStart<S>>
where S::Start: IsUnset,

Optional (Some / Option setters). The start datetime (UTC) for the backtest run. If None engine runs from the start of the data.

Source

pub fn maybe_start( self, value: Option<UnixNanos>, ) -> BacktestRunConfigBuilder<SetStart<S>>
where S::Start: IsUnset,

Optional (Some / Option setters). The start datetime (UTC) for the backtest run. If None engine runs from the start of the data.

Source

pub fn end(self, value: UnixNanos) -> BacktestRunConfigBuilder<SetEnd<S>>
where S::End: IsUnset,

Optional (Some / Option setters). The end datetime (UTC) for the backtest run. If None engine runs to the end of the data.

Source

pub fn maybe_end( self, value: Option<UnixNanos>, ) -> BacktestRunConfigBuilder<SetEnd<S>>
where S::End: IsUnset,

Optional (Some / Option setters). The end datetime (UTC) for the backtest run. If None engine runs to the end of the data.

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> Ungil for T
where T: Send,