Struct BinanceInstrumentProviderConfig 

pub struct BinanceInstrumentProviderConfig {
    pub load_all: bool,
    pub load_ids: Option<Vec<String>>,
    pub filters: HashMap<String, Value>,
    pub filter_callable: Option<String>,
    pub log_warnings: bool,
    pub query_commission_rates: bool,
}

Configuration for Binance instrument loading.

Fields

load_all: bool

Whether to load all instruments on startup.

load_ids: Option<Vec<String>>

Specific Nautilus instrument IDs to load when load_all is false.

filters: HashMap<String, Value>

Venue filters applied while loading instruments.

Supported keys are symbols, bases, quotes, and, for Futures, contract_types. Each value may be a string or an array of strings.

filter_callable: Option<String>

Fully qualified Python callable path requested by legacy configuration.

Binance v2 rejects this field because the legacy Binance provider never applied it and Rust live clients cannot safely invoke arbitrary Python.

log_warnings: bool

Whether instrument parser failures should be logged as warnings.

query_commission_rates: bool

Whether to query account-specific commission rates for every loaded symbol.

Implementations

impl BinanceInstrumentProviderConfig

pub fn builder() -> BinanceInstrumentProviderConfigBuilder

Create an instance of BinanceInstrumentProviderConfig using the builder syntax

impl BinanceInstrumentProviderConfig

pub fn validate(&self, product_type: BinanceProductType) -> Result<()>

Validates instrument loading configuration.

Errors

Returns an error for malformed IDs, unsupported filters, or a legacy callable filter that Binance v2 cannot execute safely.

Trait Implementations

impl Clone for BinanceInstrumentProviderConfig

fn clone(&self) -> BinanceInstrumentProviderConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinanceInstrumentProviderConfig

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

Formats the value using the given formatter.

impl Default for BinanceInstrumentProviderConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for BinanceInstrumentProviderConfig

impl<'de> Deserialize<'de> for BinanceInstrumentProviderConfig

where BinanceInstrumentProviderConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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 BinanceInstrumentProviderConfig

type Target = BinanceInstrumentProviderConfig

The Python output type

type Output = Bound<'py, <BinanceInstrumentProviderConfig 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 PartialEq for BinanceInstrumentProviderConfig

fn eq(&self, other: &BinanceInstrumentProviderConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PyClass for BinanceInstrumentProviderConfig

const NAME: &str = "BinanceInstrumentProviderConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BinanceInstrumentProviderConfig

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 Binance instrument loading.

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

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 = Pyo3MethodsInventoryForBinanceInstrumentProviderConfig

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 BinanceInstrumentProviderConfig

const TEXT_SIGNATURE: &'static str = "(load_all=True, load_ids=None, filters=None, filter_callable=None, log_warnings=True, query_commission_rates=False)"

impl PyStubType for BinanceInstrumentProviderConfig

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 BinanceInstrumentProviderConfig

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.

impl Serialize for BinanceInstrumentProviderConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BinanceInstrumentProviderConfig