Struct BitmapFlags

pub struct BitmapFlags { /* private fields */ }

Bitmap flags.

Implementations

impl BitmapFlags

pub const HORIZONTAL_METRICS: BitmapFlags

Horizontal

pub const VERTICAL_METRICS: BitmapFlags

Vertical

impl BitmapFlags

pub const fn empty() -> BitmapFlags

Returns an empty set of flags.

pub const fn all() -> BitmapFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

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

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

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

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

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

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both.

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

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

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

Trait Implementations

impl Binary for BitmapFlags

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

Formats the value using the given formatter.

impl BitAnd for BitmapFlags

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

Returns the intersection between the two sets of flags.

type Output = BitmapFlags

The resulting type after applying the & operator.

impl BitAndAssign for BitmapFlags

fn bitand_assign(&mut self, other: BitmapFlags)

Disables all flags disabled in the set.

impl BitOr for BitmapFlags

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

Returns the union of the two sets of flags.

type Output = BitmapFlags

The resulting type after applying the | operator.

impl BitOrAssign for BitmapFlags

fn bitor_assign(&mut self, other: BitmapFlags)

Adds the set of flags.

impl BitXor for BitmapFlags

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

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

type Output = BitmapFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for BitmapFlags

fn bitxor_assign(&mut self, other: BitmapFlags)

Toggles the set of flags.

impl Clone for BitmapFlags

fn clone(&self) -> BitmapFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitmapFlags

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

Formats the value using the given formatter.

impl Default for BitmapFlags

fn default() -> BitmapFlags

Returns the “default value” for a type.

impl Hash for BitmapFlags

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

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

Formats the value using the given formatter.

impl Not for BitmapFlags

fn not(self) -> BitmapFlags

Returns the complement of this set of flags.

type Output = BitmapFlags

The resulting type after applying the ! operator.

impl Octal for BitmapFlags

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

Formats the value using the given formatter.

impl Ord for BitmapFlags

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BitmapFlags

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Scalar for BitmapFlags

type Raw = <u8 as Scalar>::Raw

The raw byte representation of this type.

fn to_raw(self) -> <BitmapFlags as Scalar>::Raw

Encode this type as raw big-endian bytes

fn from_raw(raw: <BitmapFlags as Scalar>::Raw) -> BitmapFlags

Create an instance of this type from raw big-endian bytes

fn read(slice: &[u8]) -> Option<Self>

Attempt to read a scalar from a slice.

impl Sub for BitmapFlags

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

Returns the set difference of the two sets of flags.

type Output = BitmapFlags

The resulting type after applying the - operator.

impl SubAssign for BitmapFlags

fn sub_assign(&mut self, other: BitmapFlags)

Disables all flags enabled in the set.

impl UpperHex for BitmapFlags

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

Formats the value using the given formatter.

impl Zeroable for BitmapFlags

fn zeroed() -> Self

Calls zeroed.

impl AnyBitPattern for BitmapFlags

impl Copy for BitmapFlags

impl Eq for BitmapFlags

impl StructuralPartialEq for BitmapFlags