Struct nimiq_messages::SignalMessageFlags

pub struct SignalMessageFlags { /* fields omitted */ }

Methods

impl SignalMessageFlags

pub const UNROUTABLE: SignalMessageFlags

pub const TTL_EXCEEDED: SignalMessageFlags

pub const fn empty() -> SignalMessageFlags

Returns an empty set of flags

pub const fn all() -> SignalMessageFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

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

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

pub const fn from_bits_truncate(bits: u8) -> SignalMessageFlags

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

pub const unsafe fn from_bits_unchecked(bits: u8) -> SignalMessageFlags

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: SignalMessageFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Extend<SignalMessageFlags> for SignalMessageFlags

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

Extends a collection with the contents of an iterator.

impl Clone for SignalMessageFlags

fn clone(&self) -> SignalMessageFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SignalMessageFlags

impl Default for SignalMessageFlags

fn default() -> SignalMessageFlags

Returns the "default value" for a type.

impl Eq for SignalMessageFlags

impl Ord for SignalMessageFlags

fn cmp(&self, other: &SignalMessageFlags) -> 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.

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

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

Restrict a value to a certain interval.

impl PartialEq<SignalMessageFlags> for SignalMessageFlags

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

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

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

This method tests for !=.

impl PartialOrd<SignalMessageFlags> for SignalMessageFlags

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

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

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

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

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

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

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

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

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

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

impl Debug for SignalMessageFlags

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

Formats the value using the given formatter.

impl Sub<SignalMessageFlags> for SignalMessageFlags

type Output = SignalMessageFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<SignalMessageFlags> for SignalMessageFlags

fn sub_assign(&mut self, other: SignalMessageFlags)

Disables all flags enabled in the set.

impl Not for SignalMessageFlags

type Output = SignalMessageFlags

The resulting type after applying the ! operator.

fn not(self) -> SignalMessageFlags

Returns the complement of this set of flags.

impl BitAnd<SignalMessageFlags> for SignalMessageFlags

type Output = SignalMessageFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<SignalMessageFlags> for SignalMessageFlags

type Output = SignalMessageFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<SignalMessageFlags> for SignalMessageFlags

type Output = SignalMessageFlags

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<SignalMessageFlags> for SignalMessageFlags

fn bitand_assign(&mut self, other: SignalMessageFlags)

Disables all flags disabled in the set.

impl BitOrAssign<SignalMessageFlags> for SignalMessageFlags

fn bitor_assign(&mut self, other: SignalMessageFlags)

Adds the set of flags.

impl BitXorAssign<SignalMessageFlags> for SignalMessageFlags

fn bitxor_assign(&mut self, other: SignalMessageFlags)

Toggles the set of flags.

impl Hash for SignalMessageFlags

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

impl StructuralEq for SignalMessageFlags

impl FromIterator<SignalMessageFlags> for SignalMessageFlags

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

Creates a value from an iterator.

impl Octal for SignalMessageFlags

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

Formats the value using the given formatter.

impl Binary for SignalMessageFlags

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

Formats the value using the given formatter.

impl LowerHex for SignalMessageFlags

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

Formats the value using the given formatter.

impl UpperHex for SignalMessageFlags

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

Formats the value using the given formatter.

impl Deserialize for SignalMessageFlags

fn deserialize<R: ReadBytesExt>(
    reader: &mut R
) -> Result<Self, SerializingError>

fn deserialize_from_vec(v: &Vec<u8>) -> Result<Self, SerializingError>

impl Serialize for SignalMessageFlags

fn serialize<W: WriteBytesExt>(
    &self,
    writer: &mut W
) -> Result<usize, SerializingError>

fn serialized_size(&self) -> usize

fn serialize_to_vec(&self) -> Vec<u8>