Struct tskit::TreeFlags

pub struct TreeFlags { /* fields omitted */ }

Specify the behavior of iterating over [Tree] objects. See [TreeSequence::tree_iterator].

Implementations

impl TreeFlags

pub const NONE: TreeFlags

Default behavior.

pub const SAMPLE_LISTS: TreeFlags

Update sample lists, enabling [Tree::samples].

pub const NO_SAMPLE_COUNTS: TreeFlags

Do not update the number of samples descending from each node. The default is to update these counts.

pub const fn empty() -> TreeFlags

Returns an empty set of flags

pub const fn all() -> TreeFlags

Returns the set containing all flags.

pub const fn bits(&self) -> tsk_flags_t

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: tsk_flags_t) -> Option<TreeFlags>

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

pub const fn from_bits_truncate(bits: tsk_flags_t) -> TreeFlags

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

pub const unsafe fn from_bits_unchecked(bits: tsk_flags_t) -> TreeFlags

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for TreeFlags

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

Formats the value using the given formatter.

impl BitAnd<TreeFlags> for TreeFlags

type Output = TreeFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<TreeFlags> for TreeFlags

fn bitand_assign(&mut self, other: TreeFlags)

Disables all flags disabled in the set.

impl BitOr<TreeFlags> for TreeFlags

type Output = TreeFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<TreeFlags> for TreeFlags

fn bitor_assign(&mut self, other: TreeFlags)

Adds the set of flags.

impl BitXor<TreeFlags> for TreeFlags

type Output = TreeFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<TreeFlags> for TreeFlags

fn bitxor_assign(&mut self, other: TreeFlags)

Toggles the set of flags.

impl Clone for TreeFlags

fn clone(&self) -> TreeFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TreeFlags

impl Debug for TreeFlags

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

Formats the value using the given formatter.

impl Default for TreeFlags

fn default() -> TreeFlags

Returns the “default value” for a type.

impl Eq for TreeFlags

impl Extend<TreeFlags> for TreeFlags

fn extend<T: IntoIterator<Item = TreeFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub 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 FromIterator<TreeFlags> for TreeFlags

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

Creates a value from an iterator.

impl Hash for TreeFlags

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for TreeFlags

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

Formats the value using the given formatter.

impl Not for TreeFlags

type Output = TreeFlags

The resulting type after applying the ! operator.

fn not(self) -> TreeFlags

Returns the complement of this set of flags.

impl Octal for TreeFlags

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

Formats the value using the given formatter.

impl Ord for TreeFlags

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<TreeFlags> for TreeFlags

fn eq(&self, other: &TreeFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TreeFlags) -> bool

This method tests for !=.

impl PartialOrd<TreeFlags> for TreeFlags

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl StructuralEq for TreeFlags

impl StructuralPartialEq for TreeFlags

impl Sub<TreeFlags> for TreeFlags

type Output = TreeFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<TreeFlags> for TreeFlags

fn sub_assign(&mut self, other: TreeFlags)

Disables all flags enabled in the set.

impl UpperHex for TreeFlags

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

Formats the value using the given formatter.