Struct tskit::TreeFlags [−][src]
pub struct TreeFlags { /* fields omitted */ }
Specify the behavior of iterating over [Tree
] objects.
See [TreeSequence::tree_iterator
].
Implementations
impl TreeFlags
[src]
impl TreeFlags
[src]pub const NONE: TreeFlags
[src]
Default behavior.
pub const SAMPLE_LISTS: TreeFlags
[src]
Update sample lists, enabling [Tree::samples
].
pub const NO_SAMPLE_COUNTS: TreeFlags
[src]
Do not update the number of samples descending from each node. The default is to update these counts.
pub const fn empty() -> TreeFlags
[src]
Returns an empty set of flags
pub const fn all() -> TreeFlags
[src]
Returns the set containing all flags.
pub const fn bits(&self) -> tsk_flags_t
[src]
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: tsk_flags_t) -> Option<TreeFlags>
[src]
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
[src]
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
[src]
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
pub const fn is_empty(&self) -> bool
[src]
Returns true
if no flags are currently stored.
pub const fn is_all(&self) -> bool
[src]
Returns true
if all flags are currently set.
pub const fn intersects(&self, other: TreeFlags) -> bool
[src]
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: TreeFlags) -> bool
[src]
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: TreeFlags)
[src]
Inserts the specified flags in-place.
pub fn remove(&mut self, other: TreeFlags)
[src]
Removes the specified flags in-place.
pub fn toggle(&mut self, other: TreeFlags)
[src]
Toggles the specified flags in-place.
pub fn set(&mut self, other: TreeFlags, value: bool)
[src]
Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl BitAndAssign<TreeFlags> for TreeFlags
[src]
impl BitAndAssign<TreeFlags> for TreeFlags
[src]fn bitand_assign(&mut self, other: TreeFlags)
[src]
Disables all flags disabled in the set.
impl BitOrAssign<TreeFlags> for TreeFlags
[src]
impl BitOrAssign<TreeFlags> for TreeFlags
[src]fn bitor_assign(&mut self, other: TreeFlags)
[src]
Adds the set of flags.
impl BitXorAssign<TreeFlags> for TreeFlags
[src]
impl BitXorAssign<TreeFlags> for TreeFlags
[src]fn bitxor_assign(&mut self, other: TreeFlags)
[src]
Toggles the set of flags.
impl Extend<TreeFlags> for TreeFlags
[src]
impl Extend<TreeFlags> for TreeFlags
[src]fn extend<T: IntoIterator<Item = TreeFlags>>(&mut self, iterator: T)
[src]
pub fn extend_one(&mut self, item: A)
[src]
pub fn extend_reserve(&mut self, additional: usize)
[src]
impl FromIterator<TreeFlags> for TreeFlags
[src]
impl FromIterator<TreeFlags> for TreeFlags
[src]fn from_iter<T: IntoIterator<Item = TreeFlags>>(iterator: T) -> TreeFlags
[src]
impl PartialOrd<TreeFlags> for TreeFlags
[src]
impl PartialOrd<TreeFlags> for TreeFlags
[src]impl StructuralEq for TreeFlags
[src]
impl StructuralEq for TreeFlags
[src]impl StructuralPartialEq for TreeFlags
[src]
impl StructuralPartialEq for TreeFlags
[src]Auto Trait Implementations
impl RefUnwindSafe for TreeFlags
impl RefUnwindSafe for TreeFlags
impl UnwindSafe for TreeFlags
impl UnwindSafe for TreeFlags