Struct bee_tangle::flags::Flags

pub struct Flags { /* fields omitted */ }

Flags representing the state of a message.

Implementations

impl Flags

pub const SOLID: Flags

The message is solid.

pub const MILESTONE: Flags

The message is a milestone.

pub const REFERENCED: Flags

The message has been referenced by a milestone.

pub const VALID: Flags

The message is valid.

pub const REQUESTED: Flags

The message was requested.

pub const fn empty() -> Flags

Returns an empty set of flags

pub const fn all() -> Flags

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<Flags>

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) -> Flags

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl Flags

pub fn is_solid(&self) -> bool

Return whether the flags indicate that the message is solid.

pub fn set_solid(&mut self, is_solid: bool)

Set the solid flag for this message.

pub fn is_milestone(&self) -> bool

Return whether the flags indicate that the message is a milestone.

pub fn set_milestone(&mut self, is_milestone: bool)

Set the milestone flag for this message.

pub fn is_referenced(&self) -> bool

Return whether the flags indicate that the message is referenced.

pub fn set_referenced(&mut self, is_referenced: bool)

Set the referenced flag for this message.

pub fn is_valid(&self) -> bool

Return whether the flags indicate that the message is valid.

pub fn set_valid(&mut self, is_valid: bool)

Set the valid flag for this message.

pub fn was_requested(&self) -> bool

Return whether the flags indicate that the message was requested.

pub fn set_requested(&mut self, was_requested: bool)

Set the valid flag for this message.

Trait Implementations

impl Binary for Flags

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

Formats the value using the given formatter.

impl BitAnd<Flags> for Flags

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

Returns the intersection between the two sets of flags.

type Output = Flags

The resulting type after applying the & operator.

impl BitAndAssign<Flags> for Flags

fn bitand_assign(&mut self, other: Flags)

Disables all flags disabled in the set.

impl BitOr<Flags> for Flags

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

Returns the union of the two sets of flags.

type Output = Flags

The resulting type after applying the | operator.

impl BitOrAssign<Flags> for Flags

fn bitor_assign(&mut self, other: Flags)

Adds the set of flags.

impl BitXor<Flags> for Flags

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

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

type Output = Flags

The resulting type after applying the ^ operator.

impl BitXorAssign<Flags> for Flags

fn bitxor_assign(&mut self, other: Flags)

Toggles the set of flags.

impl Clone for Flags

fn clone(&self) -> Flags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Flags

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

Formats the value using the given formatter.

impl Default for Flags

fn default() -> Flags

Returns the “default value” for a type.

impl Extend<Flags> for Flags

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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<Flags> for Flags

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

Creates a value from an iterator.

impl Hash for Flags

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 LowerHex for Flags

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

Formats the value using the given formatter.

impl Not for Flags

fn not(self) -> Flags

Returns the complement of this set of flags.

type Output = Flags

The resulting type after applying the ! operator.

impl Octal for Flags

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

Formats the value using the given formatter.

impl Ord for Flags

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl Packable for Flags

type Error = Error

Associated error type.

fn packed_len(&self) -> usize

Returns the length of the packed bytes.

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

Packs the instance to bytes and writes them to the passed writer.

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error>

Reads bytes from the passed reader and unpacks them into an instance.

fn pack_new(&self) -> Vec<u8, Global>

Packs the instance to bytes and writes them to a newly allocated vector.

fn unpack<R>(reader: &mut R) -> Result<Self, Self::Error> where
    R: Read + ?Sized, 

Reads bytes from the passed reader and unpacks them into an instance. Applies syntactic checks.

fn unpack_unchecked<R>(reader: &mut R) -> Result<Self, Self::Error> where
    R: Read + ?Sized, 

Reads bytes from the passed reader and unpacks them into an instance. Doesn’t apply syntactic checks.

impl PartialEq<Flags> for Flags

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

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

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

This method tests for !=.

impl PartialOrd<Flags> for Flags

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

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

#[must_use]

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

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

#[must_use]

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]

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

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

#[must_use]

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 Serialize for Flags

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

Serialize this value into the given Serde serializer.

impl Sub<Flags> for Flags

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

Returns the set difference of the two sets of flags.

type Output = Flags

The resulting type after applying the - operator.

impl SubAssign<Flags> for Flags

fn sub_assign(&mut self, other: Flags)

Disables all flags enabled in the set.

impl UpperHex for Flags

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

Formats the value using the given formatter.

impl Copy for Flags

impl Eq for Flags

impl StructuralEq for Flags

impl StructuralPartialEq for Flags