Struct dbn::flags::FlagSet

pub struct FlagSet { /* private fields */ }

A transparent wrapper around the bit field used in several DBN record types, namely MboMsg and record types derived from it.

Implementations

impl FlagSet

pub const fn empty() -> Self

Returns an empty FlagSet: one with no flags set.

pub const fn new(raw: u8) -> Self

Creates a new flag set from raw.

pub fn clear(&mut self) -> &mut Self

Turns all flags off, i.e. to false.

pub const fn raw(&self) -> u8

Returns the raw value.

pub fn set_raw(&mut self, raw: u8)

Sets the flags directly with a raw u8.

pub const fn any(&self) -> bool

Returns true if any of the flags are on or set to true.

pub fn is_empty(&self) -> bool

Returns true if all flags are unset/false.

pub const fn is_last(&self) -> bool

Returns true if it’s the last record in the event from the venue for a given instrument_id.

pub fn set_last(&mut self) -> Self

Sets the LAST bit flag to true to indicate this is the last record in the event for a given instrument.

pub const fn is_tob(&self) -> bool

Returns true if it’s a top-of-book record, not an individual order.

pub fn set_tob(&mut self) -> Self

Sets the TOB bit flag to true to indicate this is a top-of-book record.

pub const fn is_snapshot(&self) -> bool

Returns true if this record was sourced from a replay, such as a snapshot server.

pub fn set_snapshot(&mut self) -> Self

Sets the SNAPSHOT bit flag to true to indicate this record was sourced from a replay.

pub const fn is_mbp(&self) -> bool

Returns true if this record is an aggregated price level record, not an individual order.

pub fn set_mbp(&mut self) -> Self

Sets the MBP bit flag to true to indicate this record is an aggregated price level record.

pub const fn is_bad_ts_recv(&self) -> bool

Returns true if this record has an inaccurate ts_recv value due to clock issues or packet reordering.

pub fn set_bad_ts_recv(&mut self) -> Self

Sets the BAD_TS_RECV bit flag to true to indicate this record has an inaccurate ts_recv value.

pub const fn is_maybe_bad_book(&self) -> bool

Returns true if this record is from a channel where an unrecoverable gap was detected.

pub fn set_maybe_bad_book(&mut self) -> Self

Sets the MAYBE_BAD_BOOK bit flag to true to indicate this record is from a channel where an unrecoverable gap was detected.

Trait Implementations

impl Clone for FlagSet

fn clone(&self) -> FlagSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlagSet

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

Formats the value using the given formatter.

impl Default for FlagSet

fn default() -> FlagSet

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FlagSet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<u8> for FlagSet

fn from(raw: u8) -> Self

Converts to this type from the input type.

impl<'py> FromPyObject<'py> for FlagSet

fn extract_bound(obj: &Bound<'py, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

impl Hash for FlagSet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoPy<Py<PyAny>> for FlagSet

Available on crate feature python only.

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PartialEq for FlagSet

fn eq(&self, other: &FlagSet) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FlagSet

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for FlagSet

impl Eq for FlagSet

impl StructuralPartialEq for FlagSet