Struct HeaderFlags

pub struct HeaderFlags { /* private fields */ }

Sbix header flags.

Implementations

impl HeaderFlags

pub const ALWAYS_SET: Self = _

Bit 0: Set to 1.

pub const DRAW_OUTLINES: Self = _

Bit 1: Draw outlines.

impl HeaderFlags

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u16

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u16) -> Option<Self>

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

pub const fn from_bits_truncate(bits: u16) -> Self

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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: Self) -> Self

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: Self) -> Self

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 HeaderFlags

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

Formats the value using the given formatter.

impl BitAnd for HeaderFlags

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

Returns the intersection between the two sets of flags.

type Output = HeaderFlags

The resulting type after applying the & operator.

impl BitAndAssign for HeaderFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for HeaderFlags

fn bitor(self, other: HeaderFlags) -> Self

Returns the union of the two sets of flags.

type Output = HeaderFlags

The resulting type after applying the | operator.

impl BitOrAssign for HeaderFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for HeaderFlags

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

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

type Output = HeaderFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for HeaderFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for HeaderFlags

fn clone(&self) -> HeaderFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderFlags

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

Formats the value using the given formatter.

impl Default for HeaderFlags

fn default() -> HeaderFlags

Returns the “default value” for a type.

impl<'a> From<HeaderFlags> for FieldType<'a>

fn from(src: HeaderFlags) -> FieldType<'a>

Converts to this type from the input type.

impl Hash for HeaderFlags

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for HeaderFlags

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

Formats the value using the given formatter.

impl Not for HeaderFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = HeaderFlags

The resulting type after applying the ! operator.

impl Octal for HeaderFlags

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

Formats the value using the given formatter.

impl Ord for HeaderFlags

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

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

fn partial_cmp(&self, other: &HeaderFlags) -> 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 HeaderFlags

type Raw = <u16 as Scalar>::Raw

The raw byte representation of this type.

fn to_raw(self) -> Self::Raw

Encode this type as raw big-endian bytes

fn from_raw(raw: Self::Raw) -> Self

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 HeaderFlags

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

Returns the set difference of the two sets of flags.

type Output = HeaderFlags

The resulting type after applying the - operator.

impl SubAssign for HeaderFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for HeaderFlags

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

Formats the value using the given formatter.

impl Zeroable for HeaderFlags

fn zeroed() -> Self

Calls zeroed.

impl AnyBitPattern for HeaderFlags

impl Copy for HeaderFlags

impl Eq for HeaderFlags

impl StructuralPartialEq for HeaderFlags