Struct BacktestDataConfig 

pub struct BacktestDataConfig { /* private fields */ }

Represents the data configuration for one specific backtest run.

Implementations

impl BacktestDataConfig

pub fn builder() -> BacktestDataConfigBuilder

Create an instance of BacktestDataConfig using the builder syntax

impl BacktestDataConfig

pub fn catalog_backend(&self) -> CatalogBackendType

Returns the configured catalog backend.

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.

pub const fn data_type(&self) -> &NautilusDataType

pub fn catalog_path(&self) -> &str

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

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

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

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

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

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

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

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

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

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

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

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

pub fn optimize_file_loading(&self) -> bool

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

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

impl Clone for BacktestDataConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BacktestDataConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DerefToPyAny for BacktestDataConfig

impl<'a, 'py> FromPyObject<'a, 'py> for BacktestDataConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for BacktestDataConfig

type Target = BacktestDataConfig

The Python output type

type Output = Bound<'py, <BacktestDataConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for BacktestDataConfig

const NAME: &str = "BacktestDataConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BacktestDataConfig

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Represents the data configuration for one specific backtest run.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<BacktestDataConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<BacktestDataConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerImpl

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForBacktestDataConfig

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for BacktestDataConfig

const TEXT_SIGNATURE: &'static str = "(data_type, catalog_path, catalog_fs_protocol=None, catalog_fs_storage_options=None, catalog_fs_rust_storage_options=None, instrument_id=None, instrument_ids=None, start_time=None, end_time=None, filter_expr=None, client_id=None, metadata=None, bar_spec=None, bar_types=None, optimize_file_loading=None, catalog_backend=None)"

impl PyStubType for BacktestDataConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for BacktestDataConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.