pub struct MarketHoursFillModel { /* private fields */ }Expand description
Fill model that simulates varying conditions based on market hours. During low liquidity: wider spreads (one tick worse). Normal hours: standard liquidity.
Implementations§
Source§impl MarketHoursFillModel
impl MarketHoursFillModel
Sourcepub fn new(
prob_fill_on_limit: f64,
prob_slippage: f64,
random_seed: Option<u64>,
) -> Result<Self>
pub fn new( prob_fill_on_limit: f64, prob_slippage: f64, random_seed: Option<u64>, ) -> Result<Self>
Creates a new MarketHoursFillModel instance.
§Errors
Returns an error if probability parameters are not in range [0, 1].
pub fn set_low_liquidity_period(&mut self, is_low_liquidity: bool)
pub fn is_low_liquidity_period(&self) -> bool
Trait Implementations§
Source§impl Clone for MarketHoursFillModel
impl Clone for MarketHoursFillModel
Source§impl Debug for MarketHoursFillModel
impl Debug for MarketHoursFillModel
Source§impl Default for MarketHoursFillModel
impl Default for MarketHoursFillModel
Source§impl FillModel for MarketHoursFillModel
impl FillModel for MarketHoursFillModel
Source§fn is_limit_filled(&mut self) -> bool
fn is_limit_filled(&mut self) -> bool
Returns
true if a limit order should be filled based on the model.Source§fn is_slipped(&mut self) -> bool
fn is_slipped(&mut self) -> bool
Returns
true if an order fill should slip by one tick.Source§fn get_orderbook_for_fill_simulation(
&mut self,
instrument: &InstrumentAny,
_order: &OrderAny,
best_bid: Price,
best_ask: Price,
) -> Option<OrderBook>
fn get_orderbook_for_fill_simulation( &mut self, instrument: &InstrumentAny, _order: &OrderAny, best_bid: Price, best_ask: Price, ) -> Option<OrderBook>
Returns a simulated
OrderBook for fill simulation. Read moreSource§fn fill_limit_inside_spread(&self) -> bool
fn fill_limit_inside_spread(&self) -> bool
Returns whether limit orders at or inside the spread are fillable. Read more
Source§impl<'a, 'py> FromPyObject<'a, 'py> for MarketHoursFillModelwhere
Self: Clone,
impl<'a, 'py> FromPyObject<'a, 'py> for MarketHoursFillModelwhere
Self: Clone,
Source§impl<'py> IntoPyObject<'py> for MarketHoursFillModel
impl<'py> IntoPyObject<'py> for MarketHoursFillModel
Source§type Target = MarketHoursFillModel
type Target = MarketHoursFillModel
The Python output type
Source§type Output = Bound<'py, <MarketHoursFillModel as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <MarketHoursFillModel as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Performs the conversion.
Source§impl PyClass for MarketHoursFillModel
impl PyClass for MarketHoursFillModel
Source§impl PyClassImpl for MarketHoursFillModel
impl PyClassImpl for MarketHoursFillModel
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
#[pyclass(immutable_type)]
Source§const RAW_DOC: &'static CStr = /// Fill model that simulates varying conditions based on market hours.
/// During low liquidity: wider spreads (one tick worse). Normal hours: standard liquidity.
const RAW_DOC: &'static CStr = /// Fill model that simulates varying conditions based on market hours. /// During low liquidity: wider spreads (one tick worse). Normal hours: standard liquidity.
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 = <<MarketHoursFillModel as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<MarketHoursFillModel>
type Layout = <<MarketHoursFillModel as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<MarketHoursFillModel>
Description of how this class is laid out in memory
Source§type ThreadChecker = ThreadCheckerImpl
type ThreadChecker = ThreadCheckerImpl
This handles following two situations: Read more
type Inventory = Pyo3MethodsInventoryForMarketHoursFillModel
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>
Source§fn dict_offset() -> Option<PyObjectOffset>
fn dict_offset() -> Option<PyObjectOffset>
Used to provide the dictoffset slot
(equivalent to tp_dictoffset)
Source§fn weaklist_offset() -> Option<PyObjectOffset>
fn weaklist_offset() -> Option<PyObjectOffset>
Used to provide the weaklistoffset slot
(equivalent to tp_weaklistoffset
Source§impl PyClassNewTextSignature for MarketHoursFillModel
impl PyClassNewTextSignature for MarketHoursFillModel
const TEXT_SIGNATURE: &'static str = "(prob_fill_on_limit=1.0, prob_slippage=0.0, random_seed=None)"
Source§impl PyStubType for MarketHoursFillModel
impl PyStubType for MarketHoursFillModel
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.
Source§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 MarketHoursFillModel
impl PyTypeInfo for MarketHoursFillModel
Source§const NAME: &str = <Self as ::pyo3::PyClass>::NAME
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.
Source§const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE
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.
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
impl DerefToPyAny for MarketHoursFillModel
Auto Trait Implementations§
impl Freeze for MarketHoursFillModel
impl RefUnwindSafe for MarketHoursFillModel
impl Send for MarketHoursFillModel
impl Sync for MarketHoursFillModel
impl Unpin for MarketHoursFillModel
impl UnsafeUnpin for MarketHoursFillModel
impl UnwindSafe for MarketHoursFillModel
Blanket Implementations§
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§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.Source§impl<'py, T> IntoPyObjectNautilusExt<'py> for Twhere
T: IntoPyObjectExt<'py>,
impl<'py, T> IntoPyObjectNautilusExt<'py> for Twhere
T: IntoPyObjectExt<'py>,
Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
👎Deprecated since 0.27.0:
Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.