Struct tskit::TreeSequenceFlags [−][src]
pub struct TreeSequenceFlags { /* fields omitted */ }
Modify behavior of crate::TableCollection::tree_sequence
and crate::TreeSequence::new
.
Implementations
impl TreeSequenceFlags
[src]
impl TreeSequenceFlags
[src]pub const NONE: TreeSequenceFlags
[src]
Default behavior
pub const BUILD_INDEXES: TreeSequenceFlags
[src]
If used, then build table indexes if they are not present.
pub const fn empty() -> TreeSequenceFlags
[src]
Returns an empty set of flags
pub const fn all() -> TreeSequenceFlags
[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<TreeSequenceFlags>
[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) -> TreeSequenceFlags
[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) -> TreeSequenceFlags
[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: TreeSequenceFlags) -> bool
[src]
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: TreeSequenceFlags) -> bool
[src]
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: TreeSequenceFlags)
[src]
Inserts the specified flags in-place.
pub fn remove(&mut self, other: TreeSequenceFlags)
[src]
Removes the specified flags in-place.
pub fn toggle(&mut self, other: TreeSequenceFlags)
[src]
Toggles the specified flags in-place.
pub fn set(&mut self, other: TreeSequenceFlags, value: bool)
[src]
Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl BitAnd<TreeSequenceFlags> for TreeSequenceFlags
[src]
impl BitAnd<TreeSequenceFlags> for TreeSequenceFlags
[src]type Output = TreeSequenceFlags
The resulting type after applying the &
operator.
fn bitand(self, other: TreeSequenceFlags) -> TreeSequenceFlags
[src]
Returns the intersection between the two sets of flags.
impl BitAndAssign<TreeSequenceFlags> for TreeSequenceFlags
[src]
impl BitAndAssign<TreeSequenceFlags> for TreeSequenceFlags
[src]fn bitand_assign(&mut self, other: TreeSequenceFlags)
[src]
Disables all flags disabled in the set.
impl BitOr<TreeSequenceFlags> for TreeSequenceFlags
[src]
impl BitOr<TreeSequenceFlags> for TreeSequenceFlags
[src]type Output = TreeSequenceFlags
The resulting type after applying the |
operator.
fn bitor(self, other: TreeSequenceFlags) -> TreeSequenceFlags
[src]
Returns the union of the two sets of flags.
impl BitOrAssign<TreeSequenceFlags> for TreeSequenceFlags
[src]
impl BitOrAssign<TreeSequenceFlags> for TreeSequenceFlags
[src]fn bitor_assign(&mut self, other: TreeSequenceFlags)
[src]
Adds the set of flags.
impl BitXor<TreeSequenceFlags> for TreeSequenceFlags
[src]
impl BitXor<TreeSequenceFlags> for TreeSequenceFlags
[src]type Output = TreeSequenceFlags
The resulting type after applying the ^
operator.
fn bitxor(self, other: TreeSequenceFlags) -> TreeSequenceFlags
[src]
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign<TreeSequenceFlags> for TreeSequenceFlags
[src]
impl BitXorAssign<TreeSequenceFlags> for TreeSequenceFlags
[src]fn bitxor_assign(&mut self, other: TreeSequenceFlags)
[src]
Toggles the set of flags.
impl Clone for TreeSequenceFlags
[src]
impl Clone for TreeSequenceFlags
[src]fn clone(&self) -> TreeSequenceFlags
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for TreeSequenceFlags
[src]
impl Copy for TreeSequenceFlags
[src]impl Default for TreeSequenceFlags
[src]
impl Default for TreeSequenceFlags
[src]fn default() -> TreeSequenceFlags
[src]
impl Eq for TreeSequenceFlags
[src]
impl Eq for TreeSequenceFlags
[src]impl Extend<TreeSequenceFlags> for TreeSequenceFlags
[src]
impl Extend<TreeSequenceFlags> for TreeSequenceFlags
[src]fn extend<T: IntoIterator<Item = TreeSequenceFlags>>(&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<TreeSequenceFlags> for TreeSequenceFlags
[src]
impl FromIterator<TreeSequenceFlags> for TreeSequenceFlags
[src]fn from_iter<T: IntoIterator<Item = TreeSequenceFlags>>(
iterator: T
) -> TreeSequenceFlags
[src]
iterator: T
) -> TreeSequenceFlags
impl Hash for TreeSequenceFlags
[src]
impl Hash for TreeSequenceFlags
[src]impl Not for TreeSequenceFlags
[src]
impl Not for TreeSequenceFlags
[src]type Output = TreeSequenceFlags
The resulting type after applying the !
operator.
fn not(self) -> TreeSequenceFlags
[src]
Returns the complement of this set of flags.
impl Ord for TreeSequenceFlags
[src]
impl Ord for TreeSequenceFlags
[src]impl PartialEq<TreeSequenceFlags> for TreeSequenceFlags
[src]
impl PartialEq<TreeSequenceFlags> for TreeSequenceFlags
[src]fn eq(&self, other: &TreeSequenceFlags) -> bool
[src]
fn ne(&self, other: &TreeSequenceFlags) -> bool
[src]
impl PartialOrd<TreeSequenceFlags> for TreeSequenceFlags
[src]
impl PartialOrd<TreeSequenceFlags> for TreeSequenceFlags
[src]fn partial_cmp(&self, other: &TreeSequenceFlags) -> 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 TreeSequenceFlags
[src]
impl StructuralEq for TreeSequenceFlags
[src]impl Sub<TreeSequenceFlags> for TreeSequenceFlags
[src]
impl Sub<TreeSequenceFlags> for TreeSequenceFlags
[src]type Output = TreeSequenceFlags
The resulting type after applying the -
operator.
fn sub(self, other: TreeSequenceFlags) -> TreeSequenceFlags
[src]
Returns the set difference of the two sets of flags.
impl SubAssign<TreeSequenceFlags> for TreeSequenceFlags
[src]
impl SubAssign<TreeSequenceFlags> for TreeSequenceFlags
[src]fn sub_assign(&mut self, other: TreeSequenceFlags)
[src]
Disables all flags enabled in the set.
Auto Trait Implementations
impl RefUnwindSafe for TreeSequenceFlags
impl RefUnwindSafe for TreeSequenceFlags
impl Send for TreeSequenceFlags
impl Send for TreeSequenceFlags
impl Sync for TreeSequenceFlags
impl Sync for TreeSequenceFlags
impl Unpin for TreeSequenceFlags
impl Unpin for TreeSequenceFlags
impl UnwindSafe for TreeSequenceFlags
impl UnwindSafe for TreeSequenceFlags