Struct 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.

Most operations support constant evaluation, e.g.

use dbn::FlagSet;

const FLAGS: FlagSet = FlagSet::empty().set_snapshot().set_last();

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 const 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 const 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 const 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 const 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 const 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 const 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 const 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 const 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 const 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.

pub const fn is_publisher_specific(&self) -> bool

Returns true if this record has the publisher-specific flag set.

pub const fn set_publisher_specific(&mut self) -> Self

Sets the PUBLISHER_SPECIFIC bit flag to true.

Trait Implementations

impl Clone for FlagSet

fn clone(&self) -> FlagSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FlagSet

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 Eq for FlagSet

impl From<u8> for FlagSet

fn from(raw: u8) -> Self

Converts to this type from the input type.

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

type Error = PyErr

The type returned in the event of a conversion error.

fn extract(obj: Borrowed<'_, 'py, PyAny>) -> Result<Self, PyErr>

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<'py> IntoPyObject<'py> for FlagSet

Available on crate feature python only.

type Target = PyInt

The Python output type

type Output = Bound<'py, <FlagSet as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = Infallible

The type returned in the event of a conversion error.

fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error>

Performs the conversion.

impl Ord for FlagSet

fn cmp(&self, other: &FlagSet) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for FlagSet

fn partial_cmp(&self, other: &FlagSet) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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 StructuralPartialEq for FlagSet

impl WritePyRepr for FlagSet

Available on crate feature python only.

fn write_py_repr(&self, s: &mut String) -> Result

Writes a Python-style string representation to s.

const SHOULD_FLATTEN: bool = false

Whether this type’s fields should be flattened into the parent repr.