Struct DataTesterConfig 

pub struct DataTesterConfig {

    pub base: DataActorConfig,
    pub instrument_ids: Vec<InstrumentId>,
    pub client_id: Option<ClientId>,
    pub bar_types: Option<Vec<BarType>>,
    pub subscribe_book_deltas: bool,
    pub subscribe_book_depth: bool,
    pub subscribe_book_at_interval: bool,
    pub subscribe_quotes: bool,
    pub subscribe_trades: bool,
    pub subscribe_mark_prices: bool,
    pub subscribe_index_prices: bool,
    pub subscribe_funding_rates: bool,
    pub subscribe_bars: bool,
    pub subscribe_instrument: bool,
    pub subscribe_instrument_status: bool,
    pub subscribe_instrument_close: bool,
    pub subscribe_option_greeks: bool,
    pub subscribe_params: Option<Params>,
    pub request_params: Option<Params>,
    pub can_unsubscribe: bool,
    pub request_instruments: bool,
    pub request_quotes: bool,
    pub request_trades: bool,
    pub request_bars: bool,
    pub request_book_snapshot: bool,
    pub request_book_deltas: bool,
    pub request_funding_rates: bool,
    pub book_type: BookType,
    pub book_depth: Option<usize>,
    pub book_interval_ms: usize,
    pub book_levels_to_print: usize,
    pub manage_book: bool,
    pub log_data: bool,
    pub stats_interval_secs: u64,
}

Configuration for the data tester actor.

Fields

base: DataActorConfig

Base data actor configuration.

instrument_ids: Vec<InstrumentId>

Instrument IDs to subscribe to.

client_id: Option<ClientId>

Client ID to use for subscriptions.

bar_types: Option<Vec<BarType>>

Bar types to subscribe to.

subscribe_book_deltas: bool

Whether to subscribe to order book deltas.

subscribe_book_depth: bool

Whether to subscribe to order book depth snapshots.

subscribe_book_at_interval: bool

Whether to subscribe to order book at interval.

subscribe_quotes: bool

Whether to subscribe to quotes.

subscribe_trades: bool

Whether to subscribe to trades.

subscribe_mark_prices: bool

Whether to subscribe to mark prices.

subscribe_index_prices: bool

Whether to subscribe to index prices.

subscribe_funding_rates: bool

Whether to subscribe to funding rates.

subscribe_bars: bool

Whether to subscribe to bars.

subscribe_instrument: bool

Whether to subscribe to instrument updates.

subscribe_instrument_status: bool

Whether to subscribe to instrument status.

subscribe_instrument_close: bool

Whether to subscribe to instrument close.

subscribe_option_greeks: bool

Whether to subscribe to option greeks.

subscribe_params: Option<Params>

Optional parameters passed to all subscribe calls.

request_params: Option<Params>

Optional parameters passed to all request calls.

can_unsubscribe: bool

Whether unsubscribe is supported on stop.

request_instruments: bool

Whether to request instruments on start.

request_quotes: bool

Whether to request historical quotes.

request_trades: bool

Whether to request historical trades (not yet implemented).

request_bars: bool

Whether to request historical bars.

request_book_snapshot: bool

Whether to request order book snapshots.

request_book_deltas: bool

Whether to request historical order book deltas (not yet implemented).

request_funding_rates: bool

Whether to request historical funding rates.

book_type: BookType

Book type for order book subscriptions.

book_depth: Option<usize>

Order book depth for subscriptions.

book_interval_ms: usize

Order book interval in milliseconds for at_interval subscriptions.

book_levels_to_print: usize

Number of order book levels to print when logging.

manage_book: bool

Whether to manage local order book from deltas.

log_data: bool

Whether to log received data.

stats_interval_secs: u64

Stats logging interval in seconds (0 to disable).

Implementations

impl DataTesterConfig

pub fn builder() -> DataTesterConfigBuilder

Create an instance of DataTesterConfig using the builder syntax

impl DataTesterConfig

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

Validates the data tester configuration, collecting every field violation.

Errors

Returns a [ConfigError] (a [ConfigError::Multiple] when more than one field is invalid) if any field fails validation.

pub fn new(client_id: ClientId, instrument_ids: Vec<InstrumentId>) -> Self

Creates a new DataTesterConfig instance with minimal settings.

Trait Implementations

impl Clone for DataTesterConfig

fn clone(&self) -> DataTesterConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataTesterConfig

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

Formats the value using the given formatter.

impl Default for DataTesterConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for DataTesterConfig

impl<'de> Deserialize<'de> for DataTesterConfig

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

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 DataTesterConfig

type Target = DataTesterConfig

The Python output type

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

const NAME: &str = "DataTesterConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DataTesterConfig

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 data tester actor.

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

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

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 DataTesterConfig

const TEXT_SIGNATURE: &'static str = "(actor_id=None, client_id=None, instrument_ids=None, bar_types=None, subscribe_book_deltas=None, subscribe_book_depth=None, subscribe_book_at_interval=None, subscribe_quotes=None, subscribe_trades=None, subscribe_mark_prices=None, subscribe_index_prices=None, subscribe_funding_rates=None, subscribe_bars=None, subscribe_instrument=None, subscribe_instrument_status=None, subscribe_instrument_close=None, subscribe_option_greeks=None, can_unsubscribe=None, request_instruments=None, request_quotes=None, request_trades=None, request_bars=None, request_book_snapshot=None, request_book_deltas=None, request_funding_rates=None, book_depth=None, book_interval_ms=None, book_levels_to_print=None, manage_book=None, log_data=None, stats_interval_secs=None, log_events=None, log_commands=None)"

impl PyStubType for DataTesterConfig

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 DataTesterConfig

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 DataTesterConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.