Skip to main content

BacktestDataConfig

Struct BacktestDataConfig 

Source
pub struct BacktestDataConfig { /* private fields */ }
Expand description

Represents the data configuration for one specific backtest run.

Implementations§

Source§

impl BacktestDataConfig

Source

pub fn builder() -> BacktestDataConfigBuilder

Create an instance of BacktestDataConfig using the builder syntax

Source§

impl BacktestDataConfig

Source

pub fn validate(&self) -> ConfigResult<()>

Validates the data configuration, collecting every field violation.

§Errors

Returns a ConfigError (a ConfigError::Multiple when more than one field is invalid) if any field fails validation.

Source

pub const fn data_type(&self) -> NautilusDataType

Source

pub fn catalog_path(&self) -> &str

Source

pub fn catalog_fs_protocol(&self) -> Option<&str>

Source

pub fn catalog_fs_storage_options(&self) -> Option<&AHashMap<String, String>>

Source

pub fn catalog_fs_rust_storage_options( &self, ) -> Option<&AHashMap<String, String>>

Source

pub fn instrument_id(&self) -> Option<InstrumentId>

Source

pub fn instrument_ids(&self) -> Option<&[InstrumentId]>

Source

pub fn start_time(&self) -> Option<UnixNanos>

Source

pub fn end_time(&self) -> Option<UnixNanos>

Source

pub fn filter_expr(&self) -> Option<&str>

Source

pub fn client_id(&self) -> Option<ClientId>

Source

pub fn metadata(&self) -> Option<&AHashMap<String, String>>

Source

pub fn bar_spec(&self) -> Option<BarSpecification>

Source

pub fn bar_types(&self) -> Option<&[String]>

Source

pub fn optimize_file_loading(&self) -> bool

Source

pub fn query_identifiers(&self) -> Option<Vec<String>>

Constructs identifier strings for catalog queries.

Follows the same logic as Python’s BacktestDataConfig.query:

  • For bars: prefer bar_types, else construct from instrument(s) + bar_spec + “-EXTERNAL”
  • For other types: use instrument_id or instrument_ids
Source

pub fn get_instrument_ids(&self) -> Result<Vec<InstrumentId>>

Returns all instrument IDs referenced by this config.

For bar_types, extracts the instrument ID from each bar type string.

§Errors

Returns an error if any bar type string cannot be parsed.

Trait Implementations§

Source§

impl Clone for BacktestDataConfig

Source§

fn clone(&self) -> BacktestDataConfig

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

impl Debug for BacktestDataConfig

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> 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, 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
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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V