Struct DatabentoDataLoader

pub struct DatabentoDataLoader { /* private fields */ }

A Nautilus data loader for Databento Binary Encoding (DBN) format data.

Supported schemas:

• MBO -> OrderBookDelta
• MBP_1 -> (QuoteTick, Option<TradeTick>)
• MBP_10 -> OrderBookDepth10
• TBBO -> (QuoteTick, TradeTick)
• TRADES -> TradeTick
• OHLCV_1S -> Bar
• OHLCV_1M -> Bar
• OHLCV_1H -> Bar
• OHLCV_1D -> Bar
• DEFINITION -> Instrument
• IMBALANCE -> DatabentoImbalance
• STATISTICS -> DatabentoStatistics
• STATUS -> InstrumentStatus

References

https://databento.com/docs/knowledge-base/new-users/dbn-encoding

Implementations

impl DatabentoDataLoader

pub fn new(path: Option<PathBuf>) -> Result<Self>

Creates a new DatabentoDataLoader instance.

pub fn load_publishers(&mut self, path: PathBuf) -> Result<()>

Load the publishers data from the file at the given path.

pub const fn get_publishers(&self) -> &IndexMap<u16, DatabentoPublisher>

Return the internal Databento publishers currently held by the loader.

pub fn get_dataset_for_venue(&self, venue: &Venue) -> Option<&Dataset>

pub fn get_venue_for_publisher( &self, publisher_id: PublisherId, ) -> Option<&Venue>

pub fn schema_from_file(&self, path: PathBuf) -> Result<Option<String>>

pub fn read_definition_records( &mut self, path: PathBuf, ) -> Result<impl Iterator<Item = Result<InstrumentAny>> + '_>

pub fn read_records<T>( &self, path: PathBuf, instrument_id: Option<InstrumentId>, include_trades: bool, ) -> Result<impl Iterator<Item = Result<(Option<Data>, Option<Data>)>> + '_>

where T: Record + HasRType + 'static,

pub fn read_status_records<T>( &self, path: PathBuf, instrument_id: Option<InstrumentId>, ) -> Result<impl Iterator<Item = Result<InstrumentStatus>> + '_>

where T: Record + HasRType + 'static,

pub fn read_imbalance_records<T>( &self, path: PathBuf, instrument_id: Option<InstrumentId>, ) -> Result<impl Iterator<Item = Result<DatabentoImbalance>> + '_>

where T: Record + HasRType + 'static,

pub fn read_statistics_records<T>( &self, path: PathBuf, instrument_id: Option<InstrumentId>, ) -> Result<impl Iterator<Item = Result<DatabentoStatistics>> + '_>

where T: Record + HasRType + 'static,

Trait Implementations

impl HasPyGilRef for DatabentoDataLoader

type AsRefTarget = PyCell<DatabentoDataLoader>

Utility type to make Py::as_ref work.

impl IntoPy<Py<PyAny>> for DatabentoDataLoader

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PyClass for DatabentoDataLoader

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DatabentoDataLoader

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)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<DatabentoDataLoader>

This handles following two situations:

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<DatabentoDataLoader> for PyClassImplCollector<DatabentoDataLoader>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a DatabentoDataLoader

type Holder = Option<PyRef<'py, DatabentoDataLoader>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut DatabentoDataLoader

type Holder = Option<PyRefMut<'py, DatabentoDataLoader>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<DatabentoDataLoader> for PyClassImplCollector<DatabentoDataLoader>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for DatabentoDataLoader

const NAME: &'static str = "DatabentoDataLoader"

Class name.

const MODULE: Option<&'static str> = _

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

👎Deprecated since 0.21.0: PyTypeInfo::type_object will be replaced by PyTypeInfo::type_object_bound in a future PyO3 version

Returns the safe abstraction over the type object.

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

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_type_of will be replaced by PyTypeInfo::is_type_of_bound in a future PyO3 version

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

fn is_type_of_bound(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: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_exact_type_of will be replaced by PyTypeInfo::is_exact_type_of_bound in a future PyO3 version

Checks if object is an instance of this type.

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

Checks if object is an instance of this type.

impl DerefToPyAny for DatabentoDataLoader