Struct trade::api::NotificationFlags

pub struct NotificationFlags { /* fields omitted */ }

Bit flags indicating which type of notification to forward.

Methods

impl NotificationFlags

pub const ORDER_BOOK: NotificationFlags

Forward limit updates of the order book.

pub const TRADES: NotificationFlags

Forward trades.

pub const ORDERS: NotificationFlags

Forward order confirmations and updates.

pub const ALL: NotificationFlags

Forward all notifications.

pub fn empty() -> NotificationFlags

Returns an empty set of flags.

pub fn all() -> NotificationFlags

Returns the set containing all flags.

pub fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<NotificationFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub fn from_bits_truncate(bits: u8) -> NotificationFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub fn intersects(&self, other: NotificationFlags) -> bool

Returns true if there are flags common to both self and other.

pub fn contains(&self, other: NotificationFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: NotificationFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: NotificationFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: NotificationFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: NotificationFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl PartialOrd<NotificationFlags> for NotificationFlags

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Ord for NotificationFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl PartialEq<NotificationFlags> for NotificationFlags

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Clone for NotificationFlags

fn clone(&self) -> NotificationFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Extend<NotificationFlags> for NotificationFlags

fn extend<T: IntoIterator<Item = NotificationFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl Copy for NotificationFlags

impl Eq for NotificationFlags

impl Debug for NotificationFlags

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

Formats the value using the given formatter.

impl Sub<NotificationFlags> for NotificationFlags

type Output = NotificationFlags

The resulting type after applying the - operator.

fn sub(self, other: NotificationFlags) -> NotificationFlags

Returns the set difference of the two sets of flags.

impl SubAssign<NotificationFlags> for NotificationFlags

fn sub_assign(&mut self, other: NotificationFlags)

Disables all flags enabled in the set.

impl Not for NotificationFlags

type Output = NotificationFlags

The resulting type after applying the ! operator.

fn not(self) -> NotificationFlags

Returns the complement of this set of flags.

impl BitAnd<NotificationFlags> for NotificationFlags

type Output = NotificationFlags

The resulting type after applying the & operator.

fn bitand(self, other: NotificationFlags) -> NotificationFlags

Returns the intersection between the two sets of flags.

impl BitOr<NotificationFlags> for NotificationFlags

type Output = NotificationFlags

The resulting type after applying the | operator.

fn bitor(self, other: NotificationFlags) -> NotificationFlags

Returns the union of the two sets of flags.

impl BitXor<NotificationFlags> for NotificationFlags

type Output = NotificationFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: NotificationFlags) -> NotificationFlags

Returns the left flags, but with all the right flags toggled.

impl BitAndAssign<NotificationFlags> for NotificationFlags

fn bitand_assign(&mut self, other: NotificationFlags)

Disables all flags disabled in the set.

impl BitOrAssign<NotificationFlags> for NotificationFlags

fn bitor_assign(&mut self, other: NotificationFlags)

Adds the set of flags.

impl BitXorAssign<NotificationFlags> for NotificationFlags

fn bitxor_assign(&mut self, other: NotificationFlags)

Toggles the set of flags.

impl Hash for NotificationFlags

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,

Feeds a slice of this type into the given [Hasher].

impl FromIterator<NotificationFlags> for NotificationFlags

fn from_iter<T: IntoIterator<Item = NotificationFlags>>(     iterator: T ) -> NotificationFlags

Creates a value from an iterator.

impl Octal for NotificationFlags

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

Formats the value using the given formatter.

impl Binary for NotificationFlags

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

Formats the value using the given formatter.

impl LowerHex for NotificationFlags

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

Formats the value using the given formatter.

impl UpperHex for NotificationFlags

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

Formats the value using the given formatter.