Struct BinanceDataClientConfig 

pub struct BinanceDataClientConfig {
    pub product_types: Vec<BinanceProductType>,
    pub environment: BinanceEnvironment,
    pub base_url_http: Option<String>,
    pub base_url_ws: Option<String>,
    pub api_key: Option<String>,
    pub api_secret: Option<String>,
    pub instrument_status_poll_secs: u64,
    pub transport_backend: TransportBackend,
}

Configuration for Binance data client.

Ed25519 API keys are required for SBE WebSocket streams.

Fields

product_types: Vec<BinanceProductType>

Product types to subscribe to.

environment: BinanceEnvironment

Environment (mainnet or testnet).

base_url_http: Option<String>

Optional base URL override for HTTP API.

base_url_ws: Option<String>

Optional base URL override for WebSocket.

Live USD-M Futures data overrides are normalized onto the matching /market/ws and /public/ws routes.

api_key: Option<String>

API key (Ed25519).

api_secret: Option<String>

API secret (Ed25519 base64-encoded or PEM).

instrument_status_poll_secs: u64

Interval in seconds for polling exchange info to detect instrument status changes (e.g. Trading -> Halt). Set to 0 to disable. Defaults to 3600 (60 minutes).

transport_backend: TransportBackend

WebSocket transport backend (defaults to Tungstenite).

Implementations

impl BinanceDataClientConfig

pub fn builder() -> BinanceDataClientConfigBuilder

Create an instance of BinanceDataClientConfig using the builder syntax

Trait Implementations

impl ClientConfig for BinanceDataClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for BinanceDataClientConfig

fn clone(&self) -> BinanceDataClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinanceDataClientConfig

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

Formats the value using the given formatter.

impl Default for BinanceDataClientConfig

fn default() -> Self

Returns the “default value” for a type.

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

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 BinanceDataClientConfig

type Target = BinanceDataClientConfig

The Python output type

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

const NAME: &str = "BinanceDataClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BinanceDataClientConfig

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 data client. /// /// Ed25519 API keys are required for SBE WebSocket streams.

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

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

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 BinanceDataClientConfig

const TEXT_SIGNATURE: &'static str = "(product_types=None, environment=None, base_url_http=None, base_url_ws=None, api_key=None, api_secret=None, instrument_status_poll_secs=None)"

impl PyStubType for BinanceDataClientConfig

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 BinanceDataClientConfig

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 DerefToPyAny for BinanceDataClientConfig