Struct FrameFlags

pub struct FrameFlags(/* private fields */);

Flags that can be applied to frames

Implementations

impl FrameFlags

pub const EMPTY: FrameFlags

An empty set of flags

pub const ALLOCATED: FrameFlags

We allocated this frame on the heap, we need to deallocated it when popping

pub const MOVED: FrameFlags

This value was moved out of — it’s not part of the value we’re building and we shouldn’t error out when we build and we notice it’s not initialized. In fact, it should not be tracked at all.

impl FrameFlags

pub const fn empty() -> FrameFlags

Get a flags value with all bits unset.

pub const fn all() -> FrameFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u64

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u64) -> Option<FrameFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u64) -> FrameFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> FrameFlags

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<FrameFlags>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: FrameFlags) -> FrameFlags

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: FrameFlags) -> FrameFlags

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: FrameFlags) -> FrameFlags

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: FrameFlags) -> FrameFlags

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> FrameFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FrameFlags

pub const fn iter(&self) -> Iter<FrameFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<FrameFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for FrameFlags

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

Formats the value using the given formatter.

impl BitAnd for FrameFlags

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

The bitwise and (&) of the bits in two flags values.

type Output = FrameFlags

The resulting type after applying the & operator.

impl BitAndAssign for FrameFlags

fn bitand_assign(&mut self, other: FrameFlags)

The bitwise and (&) of the bits in two flags values.

impl BitOr for FrameFlags

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

The bitwise or (|) of the bits in two flags values.

type Output = FrameFlags

The resulting type after applying the | operator.

impl BitOrAssign for FrameFlags

fn bitor_assign(&mut self, other: FrameFlags)

The bitwise or (|) of the bits in two flags values.

impl BitXor for FrameFlags

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = FrameFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for FrameFlags

fn bitxor_assign(&mut self, other: FrameFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for FrameFlags

fn clone(&self) -> FrameFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameFlags

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

Formats the value using the given formatter.

impl Extend<FrameFlags> for FrameFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = FrameFlags>,

The bitwise or (|) of the bits in each flags value.

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

const FLAGS: &'static [Flag<FrameFlags>]

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> FrameFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<FrameFlags> for FrameFlags

fn from_iter<T>(iterator: T) -> FrameFlags

where T: IntoIterator<Item = FrameFlags>,

The bitwise or (|) of the bits in each flags value.

impl Hash for FrameFlags

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

where __H: Hasher,

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 IntoIterator for FrameFlags

type Item = FrameFlags

The type of the elements being iterated over.

type IntoIter = Iter<FrameFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <FrameFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for FrameFlags

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

Formats the value using the given formatter.

impl Not for FrameFlags

fn not(self) -> FrameFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = FrameFlags

The resulting type after applying the ! operator.

impl Octal for FrameFlags

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

Formats the value using the given formatter.

impl PartialEq for FrameFlags

fn eq(&self, other: &FrameFlags) -> 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 Sub for FrameFlags

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = FrameFlags

The resulting type after applying the - operator.

impl SubAssign for FrameFlags

fn sub_assign(&mut self, other: FrameFlags)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for FrameFlags

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

Formats the value using the given formatter.

impl Copy for FrameFlags

impl Eq for FrameFlags

impl StructuralPartialEq for FrameFlags