pub struct OrderBookImbalanceConfig {
pub base: StrategyConfig,
pub instrument_id: InstrumentId,
pub max_trade_size: Quantity,
pub trigger_min_size: Decimal,
pub trigger_imbalance_ratio: Decimal,
pub min_seconds_between_triggers: f64,
pub book_type: BookType,
pub time_in_force: TimeInForce,
pub log_interval: u64,
pub dry_run: bool,
}Expand description
Configuration for the current-book imbalance strategy.
Fields§
§base: StrategyConfigBase strategy configuration.
instrument_id: InstrumentIdInstrument to subscribe to and trade.
max_trade_size: QuantityMaximum order size, truncated to the instrument’s size precision.
trigger_min_size: DecimalThe larger best size must exceed this threshold.
trigger_imbalance_ratio: DecimalThe smaller/larger best-size ratio must be below this threshold in (0, 1).
min_seconds_between_triggers: f64Minimum elapsed seconds between eligible signals.
book_type: BookTypeBook representation used by the managed subscription.
time_in_force: TimeInForceImmediate execution policy: FOK requires a full fill; IOC permits partial fills.
log_interval: u64Snapshot logging interval in book updates, or zero to disable.
dry_run: boolReports signals without submitting, canceling, or closing orders, including on stop.
Implementations§
Source§impl OrderBookImbalanceConfig
impl OrderBookImbalanceConfig
Sourcepub fn builder() -> OrderBookImbalanceConfigBuilder
pub fn builder() -> OrderBookImbalanceConfigBuilder
Create an instance of OrderBookImbalanceConfig using the builder syntax
Trait Implementations§
Source§impl Clone for OrderBookImbalanceConfig
impl Clone for OrderBookImbalanceConfig
Source§impl Debug for OrderBookImbalanceConfig
impl Debug for OrderBookImbalanceConfig
impl DerefToPyAny for OrderBookImbalanceConfig
Source§impl<'a, 'py> FromPyObject<'a, 'py> for OrderBookImbalanceConfigwhere
Self: Clone,
impl<'a, 'py> FromPyObject<'a, 'py> for OrderBookImbalanceConfigwhere
Self: Clone,
Source§impl<'py> IntoPyObject<'py> for OrderBookImbalanceConfig
impl<'py> IntoPyObject<'py> for OrderBookImbalanceConfig
Source§type Target = OrderBookImbalanceConfig
type Target = OrderBookImbalanceConfig
The Python output type
Source§type Output = Bound<'py, OrderBookImbalanceConfig>
type Output = Bound<'py, OrderBookImbalanceConfig>
The smart pointer type to use. Read more
Source§fn into_pyobject(self, py: Python<'py>) -> PyResult<Bound<'py, Self>>
fn into_pyobject(self, py: Python<'py>) -> PyResult<Bound<'py, Self>>
Performs the conversion.
Source§impl PyClass for OrderBookImbalanceConfig
impl PyClass for OrderBookImbalanceConfig
Source§impl PyClassImpl for OrderBookImbalanceConfig
impl PyClassImpl for OrderBookImbalanceConfig
Source§const RAW_DOC: &'static CStr = /// Configuration for the current-book imbalance strategy.
const RAW_DOC: &'static CStr = /// Configuration for the current-book imbalance strategy.
Docstring for the class provided on the struct or enum. Read more
Source§const DOC: &'static CStr
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature if a constructor is defined. Read moreSource§type Layout = <<OrderBookImbalanceConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<OrderBookImbalanceConfig>
type Layout = <<OrderBookImbalanceConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<OrderBookImbalanceConfig>
Description of how this class is laid out in memory
Source§type ThreadChecker = NoopThreadChecker
type ThreadChecker = NoopThreadChecker
This handles following two situations: Read more
type Inventory = Pyo3MethodsInventoryForOrderBookImbalanceConfig
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
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
const IS_BASETYPE: bool = false
#[pyclass(subclass)]
§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
#[pyclass(immutable_type)]
§fn dict_offset() -> Option<PyObjectOffset>
fn dict_offset() -> Option<PyObjectOffset>
Used to provide the dictoffset slot
(equivalent to tp_dictoffset)
§fn weaklist_offset() -> Option<PyObjectOffset>
fn weaklist_offset() -> Option<PyObjectOffset>
Used to provide the weaklistoffset slot
(equivalent to tp_weaklistoffset
Source§impl PyClassNewTextSignature for OrderBookImbalanceConfig
impl PyClassNewTextSignature for OrderBookImbalanceConfig
const TEXT_SIGNATURE: &'static str = "(instrument_id, max_trade_size, strategy_id=None, order_id_tag=None, trigger_min_size=None, trigger_imbalance_ratio=None, min_seconds_between_triggers=1.0, book_type=..., time_in_force=..., log_interval=0, dry_run=False)"
Source§impl PyStubType for OrderBookImbalanceConfig
impl PyStubType for OrderBookImbalanceConfig
Source§fn type_output() -> TypeInfo
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
fn type_input() -> TypeInfo
The type to be used in the input signature, i.e. the arguments of the Python function or methods. Read more
Source§impl PyTypeInfo for OrderBookImbalanceConfig
impl PyTypeInfo for OrderBookImbalanceConfig
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
§fn is_type_of(object: &Bound<'_, PyAny>) -> bool
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
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
Checks if
object is an instance of this type.Auto Trait Implementations§
impl Freeze for OrderBookImbalanceConfig
impl RefUnwindSafe for OrderBookImbalanceConfig
impl Send for OrderBookImbalanceConfig
impl Sync for OrderBookImbalanceConfig
impl Unpin for OrderBookImbalanceConfig
impl UnsafeUnpin for OrderBookImbalanceConfig
impl UnwindSafe for OrderBookImbalanceConfig
Blanket Implementations§
impl<T> Allocation for T
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<'py, T> FromPyObjectOwned<'py> for Twhere
T: for<'a> FromPyObject<'a, 'py>,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
Converts
self into an owned Python object, dropping type information.§fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>
fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>
Converts
self into an owned Python object, dropping type information and unbinding it
from the 'py lifetime.§fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>
fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>
Converts
self into a Python object. Read more§impl<'py, T> IntoPyObjectNautilusExt<'py> for Twhere
T: IntoPyObjectExt<'py>,
impl<'py, T> IntoPyObjectNautilusExt<'py> for Twhere
T: IntoPyObjectExt<'py>,
§fn into_py_any_unwrap(self, py: Python<'py>) -> Py<PyAny>where
Self: IntoPyObject<'py, Error = !>,
fn into_py_any_unwrap(self, py: Python<'py>) -> Py<PyAny>where
Self: IntoPyObject<'py, Error = !>,
Converts
self into a [Py<PyAny>] when the underlying conversion is infallible.§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
§fn type_check(object: &Bound<'_, PyAny>) -> bool
fn type_check(object: &Bound<'_, PyAny>) -> bool
§fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>
fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>
Returns the expected type as a possible argument for the
isinstance and issubclass function. Read more