Struct TreeSequenceFlags 

pub struct TreeSequenceFlags(/* private fields */);

Modify behavior of crate::TableCollection::tree_sequence and crate::TreeSequence::new.

Examples

Default (empty) flags

let f = TreeSequenceFlags::default();

Builder API

These methods may be chained.

let f = TreeSequenceFlags::default().build_indexes();
assert_eq!(f, TreeSequenceFlags::BUILD_INDEXES);

Implementations

impl TreeSequenceFlags

pub const BUILD_INDEXES: Self

If used, then build table indexes if they are not present.

pub const COMPUTE_MUTATION_PARENTS: Self

Compute mutation parents during initialization, overwriting pre-existing parents in the mutation table

pub fn build_indexes(self) -> Self

Set BUILD_INDEXES

pub fn compute_mutation_parents(self) -> Self

Set COMPUTE_MUTATION_PARENTS

pub fn bits(&self) -> RawFlags

pub fn all() -> Self

pub fn contains<I>(&self, bit: I) -> bool

where I: Into<Self> + Copy,

Trait Implementations

impl BitAnd for TreeSequenceFlags

type Output = TreeSequenceFlags

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for TreeSequenceFlags

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for TreeSequenceFlags

type Output = TreeSequenceFlags

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for TreeSequenceFlags

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for TreeSequenceFlags

type Output = TreeSequenceFlags

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for TreeSequenceFlags

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for TreeSequenceFlags

fn clone(&self) -> TreeSequenceFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TreeSequenceFlags

impl Debug for TreeSequenceFlags

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

Formats the value using the given formatter.

impl Default for TreeSequenceFlags

fn default() -> TreeSequenceFlags

Returns the “default value” for a type.

impl Eq for TreeSequenceFlags

impl From<u32> for TreeSequenceFlags

fn from(value: RawFlags) -> Self

Converts to this type from the input type.

impl Hash for TreeSequenceFlags

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 Ord for TreeSequenceFlags

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TreeSequenceFlags

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