Struct tskit::TableIntegrityCheckFlags
source · #[repr(transparent)]pub struct TableIntegrityCheckFlags { /* private fields */ }
Expand description
Flags to affect the behavior of
TableCollection::check_integrity
.
Examples
Default (empty) flags
let f = tskit::TableIntegrityCheckFlags::default();
assert_eq!(f, tskit::TableIntegrityCheckFlags::NONE);
Builder API
These methods may be chained.
let f = tskit::TableIntegrityCheckFlags::default().check_edge_ordering();
assert_eq!(f, tskit::TableIntegrityCheckFlags::CHECK_EDGE_ORDERING);
let f = tskit::TableIntegrityCheckFlags::default().check_site_ordering();
assert_eq!(f, tskit::TableIntegrityCheckFlags::CHECK_SITE_ORDERING);
let f = tskit::TableIntegrityCheckFlags::default().check_site_duplicates();
assert_eq!(f, tskit::TableIntegrityCheckFlags::CHECK_SITE_DUPLICATES);
let f = tskit::TableIntegrityCheckFlags::default().check_mutation_ordering();
assert_eq!(f, tskit::TableIntegrityCheckFlags::CHECK_MUTATION_ORDERING);
let f = tskit::TableIntegrityCheckFlags::default().check_individual_ordering();
assert_eq!(f, tskit::TableIntegrityCheckFlags::CHECK_INDIVIDUAL_ORDERING);
let f = tskit::TableIntegrityCheckFlags::default().check_migration_ordering();
assert_eq!(f, tskit::TableIntegrityCheckFlags::CHECK_MIGRATION_ORDERING);
let f = tskit::TableIntegrityCheckFlags::default().check_indexes();
assert_eq!(f, tskit::TableIntegrityCheckFlags::CHECK_INDEXES);
let f = tskit::TableIntegrityCheckFlags::default().check_trees();
assert_eq!(f, tskit::TableIntegrityCheckFlags::CHECK_TREES);
Implementations§
source§impl TableIntegrityCheckFlags
impl TableIntegrityCheckFlags
sourcepub const CHECK_EDGE_ORDERING: Self = _
pub const CHECK_EDGE_ORDERING: Self = _
Check that edges are ordered
sourcepub const CHECK_SITE_ORDERING: Self = _
pub const CHECK_SITE_ORDERING: Self = _
Check that sites are ordered
sourcepub const CHECK_SITE_DUPLICATES: Self = _
pub const CHECK_SITE_DUPLICATES: Self = _
Check for duplicated sites
sourcepub const CHECK_MUTATION_ORDERING: Self = _
pub const CHECK_MUTATION_ORDERING: Self = _
Check that mutations are ordered
sourcepub const CHECK_INDIVIDUAL_ORDERING: Self = _
pub const CHECK_INDIVIDUAL_ORDERING: Self = _
Check that individuals are ordered
sourcepub const CHECK_MIGRATION_ORDERING: Self = _
pub const CHECK_MIGRATION_ORDERING: Self = _
Check that migrations are ordered
sourcepub const CHECK_INDEXES: Self = _
pub const CHECK_INDEXES: Self = _
Check that table indexes are valid
sourcepub const CHECK_TREES: Self = _
pub const CHECK_TREES: Self = _
Check tree integrity. Enables most or all of the preceding options.
sourcepub const fn from_bits(bits: RawFlags) -> Option<Self>
pub const fn from_bits(bits: RawFlags) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: RawFlags) -> Self
pub const fn from_bits_truncate(bits: RawFlags) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: RawFlags) -> Self
pub const unsafe fn from_bits_unchecked(bits: RawFlags) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
source§impl TableIntegrityCheckFlags
impl TableIntegrityCheckFlags
sourcepub fn check_edge_ordering(self) -> Self
pub fn check_edge_ordering(self) -> Self
sourcepub fn check_site_ordering(self) -> Self
pub fn check_site_ordering(self) -> Self
sourcepub fn check_individual_ordering(self) -> Self
pub fn check_individual_ordering(self) -> Self
sourcepub fn check_mutation_ordering(self) -> Self
pub fn check_mutation_ordering(self) -> Self
sourcepub fn check_migration_ordering(self) -> Self
pub fn check_migration_ordering(self) -> Self
sourcepub fn check_site_duplicates(self) -> Self
pub fn check_site_duplicates(self) -> Self
sourcepub fn check_indexes(self) -> Self
pub fn check_indexes(self) -> Self
Set CHECK_INDEXES
sourcepub fn check_trees(self) -> Self
pub fn check_trees(self) -> Self
Set CHECK_TREES
Trait Implementations§
source§impl Binary for TableIntegrityCheckFlags
impl Binary for TableIntegrityCheckFlags
source§impl BitAndAssign<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
impl BitAndAssign<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
impl BitOr<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
source§fn bitor(self, other: TableIntegrityCheckFlags) -> Self
fn bitor(self, other: TableIntegrityCheckFlags) -> Self
Returns the union of the two sets of flags.
§type Output = TableIntegrityCheckFlags
type Output = TableIntegrityCheckFlags
|
operator.source§impl BitOrAssign<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
impl BitOrAssign<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
impl BitXorAssign<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for TableIntegrityCheckFlags
impl Clone for TableIntegrityCheckFlags
source§fn clone(&self) -> TableIntegrityCheckFlags
fn clone(&self) -> TableIntegrityCheckFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for TableIntegrityCheckFlags
impl Debug for TableIntegrityCheckFlags
source§impl Default for TableIntegrityCheckFlags
impl Default for TableIntegrityCheckFlags
source§fn default() -> TableIntegrityCheckFlags
fn default() -> TableIntegrityCheckFlags
source§impl Extend<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
impl Extend<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl From<u32> for TableIntegrityCheckFlags
impl From<u32> for TableIntegrityCheckFlags
source§impl FromIterator<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
impl FromIterator<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for TableIntegrityCheckFlags
impl Hash for TableIntegrityCheckFlags
source§impl LowerHex for TableIntegrityCheckFlags
impl LowerHex for TableIntegrityCheckFlags
source§impl Not for TableIntegrityCheckFlags
impl Not for TableIntegrityCheckFlags
source§impl Octal for TableIntegrityCheckFlags
impl Octal for TableIntegrityCheckFlags
source§impl Ord for TableIntegrityCheckFlags
impl Ord for TableIntegrityCheckFlags
source§fn cmp(&self, other: &TableIntegrityCheckFlags) -> Ordering
fn cmp(&self, other: &TableIntegrityCheckFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
impl PartialEq<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
source§fn eq(&self, other: &TableIntegrityCheckFlags) -> bool
fn eq(&self, other: &TableIntegrityCheckFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
impl PartialOrd<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
source§fn partial_cmp(&self, other: &TableIntegrityCheckFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &TableIntegrityCheckFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl SubAssign<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
impl SubAssign<TableIntegrityCheckFlags> for TableIntegrityCheckFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.