Struct PointTypeFlags

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

point flag indicating its type.

Only the _POINT combinations are valid when hashed.

Implementations

impl PointTypeFlags

pub const EMPTY: PointTypeFlags

pub const LIVE: PointTypeFlags

pub const NOT_ENTOMBED: PointTypeFlags

pub const DATA: PointTypeFlags

pub const LINK: PointTypeFlags

pub const SIGNATURE: PointTypeFlags

pub const DATA_POINT: PointTypeFlags

pub const LINK_POINT: PointTypeFlags

pub const KEY_POINT: PointTypeFlags

impl PointTypeFlags

pub const fn empty() -> PointTypeFlags

Get a flags value with all bits unset.

pub const fn all() -> PointTypeFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

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

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

Convert from a bits value.

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

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> PointTypeFlags

Convert from a bits value exactly.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub const fn complement(self) -> PointTypeFlags

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

impl PointTypeFlags

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

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

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.

impl PointTypeFlags

pub const fn is_entombed(&self) -> bool

impl PointTypeFlags

pub const fn as_str(self) -> &'static str

pub fn unchecked_from(b: u8) -> PointTypeFlags

Trait Implementations

impl Binary for PointTypeFlags

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

Formats the value using the given formatter.

impl BitAnd for PointTypeFlags

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

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

type Output = PointTypeFlags

The resulting type after applying the & operator.

impl BitAndAssign for PointTypeFlags

fn bitand_assign(&mut self, other: PointTypeFlags)

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

impl BitOr for PointTypeFlags

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

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

type Output = PointTypeFlags

The resulting type after applying the | operator.

impl BitOrAssign for PointTypeFlags

fn bitor_assign(&mut self, other: PointTypeFlags)

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

impl BitXor for PointTypeFlags

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

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

type Output = PointTypeFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for PointTypeFlags

fn bitxor_assign(&mut self, other: PointTypeFlags)

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

impl Clone for PointTypeFlags

fn clone(&self) -> PointTypeFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PointTypeFlags

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

Formats the value using the given formatter.

impl Display for PointTypeFlags

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

Formats the value using the given formatter.

impl Extend<PointTypeFlags> for PointTypeFlags

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

where T: IntoIterator<Item = PointTypeFlags>,

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 PointTypeFlags

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

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> PointTypeFlags

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

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

where T: IntoIterator<Item = PointTypeFlags>,

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

impl IntoIterator for PointTypeFlags

type Item = PointTypeFlags

The type of the elements being iterated over.

type IntoIter = Iter<PointTypeFlags>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl LowerHex for PointTypeFlags

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

Formats the value using the given formatter.

impl Not for PointTypeFlags

fn not(self) -> PointTypeFlags

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

type Output = PointTypeFlags

The resulting type after applying the ! operator.

impl Octal for PointTypeFlags

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

Formats the value using the given formatter.

impl Ord for PointTypeFlags

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

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

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

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

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 = PointTypeFlags

The resulting type after applying the - operator.

impl SubAssign for PointTypeFlags

fn sub_assign(&mut self, other: PointTypeFlags)

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 ToABE for PointTypeFlags

fn write_abe(&self, out: &mut dyn FnMut(ABE))

fn write_abe_str(&self, out: &mut dyn Write) -> Result<(), Error>

fn to_abe_str(&self) -> String

fn to_abe(&self) -> Vec<ABE>

impl UpperHex for PointTypeFlags

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

Formats the value using the given formatter.

impl Copy for PointTypeFlags

impl Eq for PointTypeFlags

impl StructuralPartialEq for PointTypeFlags