Struct DeriveDataClientConfig 

pub struct DeriveDataClientConfig {

    pub environment: DeriveEnvironment,
    pub base_url_rest: Option<String>,
    pub base_url_ws: Option<String>,
    pub proxy_url: Option<SecretString>,
    pub http_timeout_secs: u64,
    pub ws_timeout_secs: Option<u64>,
    pub book_snapshot_timeout_secs: u64,
    pub book_stale_threshold_secs: u64,
    pub update_instruments_interval_mins: u64,
    pub currencies: Vec<String>,
    pub include_expired: bool,
    pub auto_load_missing_instruments: bool,
    pub transport_backend: TransportBackend,
}

Configuration for the Derive data client.

Fields

environment: DeriveEnvironment

The Derive environment to connect to.

base_url_rest: Option<String>

Override for the REST API base URL.

base_url_ws: Option<String>

Override for the WebSocket URL.

proxy_url: Option<SecretString>

Optional proxy URL for HTTP and WebSocket transports.

http_timeout_secs: u64

HTTP timeout in seconds.

ws_timeout_secs: Option<u64>

Optional per-operation WebSocket timeout in seconds (login, subscribe, reads, writes). When unset, the low-level WS_REQUEST_TIMEOUT applies.

book_snapshot_timeout_secs: u64

Maximum wait for an initial, post-reconnect, or recovery book snapshot, in seconds. A zero value disables snapshot deadlines.

book_stale_threshold_secs: u64

Maximum receive age of advancing book snapshots before recovery, in seconds. Empty snapshots count as updates; a zero value disables stale book recovery.

update_instruments_interval_mins: u64

Interval in minutes for refreshing instruments of configured currencies. A zero value disables periodic refresh.

currencies: Vec<String>

Underlying currencies to load on connect. Empty means lazy-load by instrument ID when subscribing.

include_expired: bool

Whether instrument loading includes expired instruments.

auto_load_missing_instruments: bool

Whether subscriptions may fetch missing instruments before sending the WebSocket request.

transport_backend: TransportBackend

WebSocket transport backend (defaults to Sockudo).

Implementations

impl DeriveDataClientConfig

pub fn builder() -> DeriveDataClientConfigBuilder

Create an instance of DeriveDataClientConfig using the builder syntax

impl DeriveDataClientConfig

pub fn new() -> Self

pub fn validate(&self) -> ConfigResult<()>

Validates that configured currency entries contain no duplicates.

Nonblank currencies must also be distinct after trimming.

Errors

Returns an error if currency entries repeat or nonblank entries match after trimming.

pub fn rest_url(&self) -> String

Returns the REST API base URL, respecting environment and overrides.

pub fn ws_url(&self) -> String

Returns the WebSocket URL, respecting environment and overrides.

Trait Implementations

impl ClientConfig for DeriveDataClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for DeriveDataClientConfig

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 DeriveDataClientConfig

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

Formats the value using the given formatter.

impl Default for DeriveDataClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for DeriveDataClientConfig

impl<'de> Deserialize<'de> for DeriveDataClientConfig

where DeriveDataClientConfig: 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 DeriveDataClientConfig

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 DeriveDataClientConfig

type Target = DeriveDataClientConfig

The Python output type

type Output = Bound<'py, DeriveDataClientConfig>

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>) -> PyResult<Bound<'py, Self>>

Performs the conversion.

impl PyClass for DeriveDataClientConfig

const NAME: &str = "DeriveDataClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DeriveDataClientConfig

const MODULE: Option<&str>

Module which the class will be associated with.

const RAW_DOC: &'static CStr = /// Configuration for the Derive 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 = <<DeriveDataClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<DeriveDataClientConfig>

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

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 __traverse__(&self, visit: PyVisit<'_>) -> Result<(), PyTraverseError>

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

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 DeriveDataClientConfig

const TEXT_SIGNATURE: &'static str = "(base_url_rest=None, base_url_ws=None, proxy_url=None, environment=None, http_timeout_secs=None, ws_timeout_secs=None, update_instruments_interval_mins=None, currencies=None, include_expired=None, auto_load_missing_instruments=None, transport_backend=None, book_snapshot_timeout_secs=None, book_stale_threshold_secs=None)"

impl PyStubType for DeriveDataClientConfig

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 DeriveDataClientConfig

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 DeriveDataClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.