Struct DatabentoDataClientConfig 

pub struct DatabentoDataClientConfig {
    pub publishers_filepath: PathBuf,
    pub venue_dataset_map: IndexMap<String, String>,
    pub use_exchange_as_venue: bool,
    pub bars_timestamp_on_close: bool,
    pub reconnect_timeout_mins: Option<u64>,
    /* private fields */
}

Configuration for the Databento data client.

Fields

publishers_filepath: PathBuf

Path to publishers.json file.

venue_dataset_map: IndexMap<String, String>

Venue-to-dataset overrides applied on top of the publishers.json mappings.

use_exchange_as_venue: bool

Whether to use exchange as venue for GLBX instruments.

bars_timestamp_on_close: bool

Whether to timestamp bars on close.

reconnect_timeout_mins: Option<u64>

Reconnection timeout in minutes (None for infinite retries).

Implementations

impl DatabentoDataClientConfig

pub fn new( api_key: impl Into<String>, publishers_filepath: PathBuf, use_exchange_as_venue: bool, bars_timestamp_on_close: bool, ) -> Self

Creates a new DatabentoDataClientConfig instance.

pub fn api_key(&self) -> &str

Returns the API key associated with this config.

pub fn api_key_masked(&self) -> String

Returns a masked version of the API key for logging purposes.

Trait Implementations

impl ClientConfig for DatabentoDataClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for DatabentoDataClientConfig

fn clone(&self) -> DatabentoDataClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DatabentoDataClientConfig

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

Formats the value using the given formatter.

impl DerefToPyAny for DatabentoDataClientConfig

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

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 DatabentoDataClientConfig

type Target = DatabentoDataClientConfig

The Python output type

type Output = Bound<'py, <DatabentoDataClientConfig 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 DatabentoDataClientConfig

const NAME: &str = "DatabentoDataClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DatabentoDataClientConfig

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 = /// Configuration for the Databento data client.

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 = <<DatabentoDataClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<DatabentoDataClientConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForDatabentoDataClientConfig

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 DatabentoDataClientConfig

const TEXT_SIGNATURE: &'static str = "(api_key, publishers_filepath, use_exchange_as_venue=False, bars_timestamp_on_close=True, venue_dataset_map=None)"

impl PyStubType for DatabentoDataClientConfig

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 DatabentoDataClientConfig

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.