Struct NodeFlags

pub struct NodeFlags { /* private fields */ }

Node flags

Examples

Default (empty) flags

let f = tskit::NodeFlags::default();
assert_eq!(f, tskit::NodeFlags::NONE);

Create a sample node

Creating a sample node is such a common task that it is supported via a constructor:

let f = tskit::NodeFlags::new_sample();
assert_eq!(f, tskit::NodeFlags::IS_SAMPLE);

Buider API

These methods can be chained.

let f = tskit::NodeFlags::default().mark_sample();
assert_eq!(f, tskit::NodeFlags::IS_SAMPLE);

Implementations

impl NodeFlags

pub const NONE: Self

Default (empty)

pub const IS_SAMPLE: Self

Node is a sample

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

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: RawFlags) -> 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: RawFlags) -> Self

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

pub const unsafe fn from_bits_unchecked(bits: RawFlags) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

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: 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 fn set(&mut self, other: Self, value: bool)

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

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 (see Self::symmetric_difference if that is undesirable).

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.

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

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

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

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

impl NodeFlags

pub fn new_sample() -> Self

Create a new flags instance with IS_SAMPLE set.

pub fn mark_sample(self) -> Self

Set IS_SAMPLE

Note

This function is called mark_sample to not conflict with NodeFlags::is_sample, which predates it.

pub fn is_valid(&self) -> bool

We do not enforce valid flags in the library. This function will return true if any bits are set that do not correspond to allowed flags.

pub fn is_sample(&self) -> bool

Returns true if flags contains IS_SAMPLE, and false otherwise.

Trait Implementations

impl Binary for NodeFlags

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

Formats the value using the given formatter.

impl BitAnd for NodeFlags

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

Returns the intersection between the two sets of flags.

type Output = NodeFlags

The resulting type after applying the & operator.

impl BitAndAssign for NodeFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for NodeFlags

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

Returns the union of the two sets of flags.

type Output = NodeFlags

The resulting type after applying the | operator.

impl BitOrAssign for NodeFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for NodeFlags

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

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

type Output = NodeFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for NodeFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for NodeFlags

fn clone(&self) -> NodeFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeFlags

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

Formats the value using the given formatter.

impl Default for NodeFlags

fn default() -> NodeFlags

Returns the “default value” for a type.

impl Extend<NodeFlags> for NodeFlags

fn extend<T: IntoIterator<Item = Self>>(&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 From<u32> for NodeFlags

fn from(flags: RawFlags) -> Self

Converts to this type from the input type.

impl FromIterator<NodeFlags> for NodeFlags

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

Creates a value from an iterator.

impl Hash for NodeFlags

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 NodeFlags

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

Formats the value using the given formatter.

impl Not for NodeFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = NodeFlags

The resulting type after applying the ! operator.

impl Octal for NodeFlags

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

Formats the value using the given formatter.

impl Ord for NodeFlags

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

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

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

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

Returns the set difference of the two sets of flags.

type Output = NodeFlags

The resulting type after applying the - operator.

impl SubAssign for NodeFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for NodeFlags

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

Formats the value using the given formatter.

impl Copy for NodeFlags

impl Eq for NodeFlags

impl StructuralPartialEq for NodeFlags