Struct tskit::TreeFlags [−][src]
Specify the behavior of iterating over Tree
objects.
See TreeSequence::tree_iterator
.
Implementations
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 Binary for TreeFlags
[src]
impl BitAnd<TreeFlags> for TreeFlags
[src]
type Output = TreeFlags
The resulting type after applying the &
operator.
fn bitand(self, other: TreeFlags) -> TreeFlags
[src]
Returns the intersection between the two sets of flags.
impl BitAndAssign<TreeFlags> for TreeFlags
[src]
fn bitand_assign(&mut self, other: TreeFlags)
[src]
Disables all flags disabled in the set.
impl BitOr<TreeFlags> for TreeFlags
[src]
type Output = TreeFlags
The resulting type after applying the |
operator.
fn bitor(self, other: TreeFlags) -> TreeFlags
[src]
Returns the union of the two sets of flags.
impl BitOrAssign<TreeFlags> for TreeFlags
[src]
fn bitor_assign(&mut self, other: TreeFlags)
[src]
Adds the set of flags.
impl BitXor<TreeFlags> for TreeFlags
[src]
type Output = TreeFlags
The resulting type after applying the ^
operator.
fn bitxor(self, other: TreeFlags) -> TreeFlags
[src]
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign<TreeFlags> for TreeFlags
[src]
fn bitxor_assign(&mut self, other: TreeFlags)
[src]
Toggles the set of flags.
impl Clone for TreeFlags
[src]
impl Copy for TreeFlags
[src]
impl Debug for TreeFlags
[src]
impl Default for TreeFlags
[src]
impl Eq 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]
fn from_iter<T: IntoIterator<Item = TreeFlags>>(iterator: T) -> TreeFlags
[src]
impl Hash for TreeFlags
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl LowerHex for TreeFlags
[src]
impl Not for TreeFlags
[src]
type Output = TreeFlags
The resulting type after applying the !
operator.
fn not(self) -> TreeFlags
[src]
Returns the complement of this set of flags.
impl Octal for TreeFlags
[src]
impl Ord for TreeFlags
[src]
fn cmp(&self, other: &TreeFlags) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<TreeFlags> for TreeFlags
[src]
impl PartialOrd<TreeFlags> for TreeFlags
[src]
fn partial_cmp(&self, other: &TreeFlags) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl StructuralEq for TreeFlags
[src]
impl StructuralPartialEq for TreeFlags
[src]
impl Sub<TreeFlags> for TreeFlags
[src]
type Output = TreeFlags
The resulting type after applying the -
operator.
fn sub(self, other: TreeFlags) -> TreeFlags
[src]
Returns the set difference of the two sets of flags.
impl SubAssign<TreeFlags> for TreeFlags
[src]
fn sub_assign(&mut self, other: TreeFlags)
[src]
Disables all flags enabled in the set.
impl UpperHex for TreeFlags
[src]
Auto Trait Implementations
impl RefUnwindSafe for TreeFlags
impl Send for TreeFlags
impl Sync for TreeFlags
impl Unpin for TreeFlags
impl UnwindSafe for TreeFlags
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,