Struct netidx::subscriber::UpdatesFlags

pub struct UpdatesFlags { /* fields omitted */ }

Implementations

impl UpdatesFlags

pub const BEGIN_WITH_LAST: UpdatesFlags

if set, then an immediate update will be sent consisting of the last value received from the publisher.

pub const STOP_COLLECTING_LAST: UpdatesFlags

If set then the subscriber will stop storing the last value. The last method will return whatever last was before this method was called, and the passed in channel will be the only way of getting data from the subscription. This improves performance at the expense of flexibility.

pub const fn empty() -> UpdatesFlags

Returns an empty set of flags

pub const fn all() -> UpdatesFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<UpdatesFlags>

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

pub const fn from_bits_truncate(bits: u32) -> UpdatesFlags

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> UpdatesFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for UpdatesFlags

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

Formats the value using the given formatter.

impl BitAnd<UpdatesFlags> for UpdatesFlags

type Output = UpdatesFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<UpdatesFlags> for UpdatesFlags

fn bitand_assign(&mut self, other: UpdatesFlags)

Disables all flags disabled in the set.

impl BitOr<UpdatesFlags> for UpdatesFlags

type Output = UpdatesFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<UpdatesFlags> for UpdatesFlags

fn bitor_assign(&mut self, other: UpdatesFlags)

Adds the set of flags.

impl BitXor<UpdatesFlags> for UpdatesFlags

type Output = UpdatesFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<UpdatesFlags> for UpdatesFlags

fn bitxor_assign(&mut self, other: UpdatesFlags)

Toggles the set of flags.

impl Clone for UpdatesFlags

fn clone(&self) -> UpdatesFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for UpdatesFlags

impl Debug for UpdatesFlags

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

Formats the value using the given formatter.

impl Eq for UpdatesFlags

impl Extend<UpdatesFlags> for UpdatesFlags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<UpdatesFlags> for UpdatesFlags

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

Creates a value from an iterator.

impl Hash for UpdatesFlags

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for UpdatesFlags

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

Formats the value using the given formatter.

impl Not for UpdatesFlags

type Output = UpdatesFlags

The resulting type after applying the ! operator.

fn not(self) -> UpdatesFlags

Returns the complement of this set of flags.

impl Octal for UpdatesFlags

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

Formats the value using the given formatter.

impl Ord for UpdatesFlags

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<UpdatesFlags> for UpdatesFlags

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

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

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

This method tests for !=.

impl PartialOrd<UpdatesFlags> for UpdatesFlags

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for UpdatesFlags

impl StructuralPartialEq for UpdatesFlags

impl Sub<UpdatesFlags> for UpdatesFlags

type Output = UpdatesFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<UpdatesFlags> for UpdatesFlags

fn sub_assign(&mut self, other: UpdatesFlags)

Disables all flags enabled in the set.

impl UpperHex for UpdatesFlags

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

Formats the value using the given formatter.