Struct tskit::TableEqualityOptions
source · #[repr(transparent)]pub struct TableEqualityOptions { /* private fields */ }
Expand description
Modify behavior of crate::TableCollection::equals
.
Examples
Set default (empty) flags
let f = tskit::TableEqualityOptions::default();
assert_eq!(f, tskit::TableEqualityOptions::NONE);
Builder API
let f = tskit::TableEqualityOptions::default().ignore_metadata();
assert_eq!(f, tskit::TableEqualityOptions::IGNORE_METADATA);
let f = tskit::TableEqualityOptions::default().ignore_ts_metadata();
assert_eq!(f, tskit::TableEqualityOptions::IGNORE_TS_METADATA);
let f = tskit::TableEqualityOptions::default().ignore_timestamps();
assert_eq!(f, tskit::TableEqualityOptions::IGNORE_TIMESTAMPS);
let f = tskit::TableEqualityOptions::default().ignore_provenance();
assert_eq!(f, tskit::TableEqualityOptions::IGNORE_PROVENANCE);
let f = f.ignore_metadata();
assert!(f.contains(tskit::TableEqualityOptions::IGNORE_PROVENANCE));
assert!(f.contains(tskit::TableEqualityOptions::IGNORE_METADATA));
Method chaining
let f = tskit::TableEqualityOptions::default().ignore_provenance().ignore_metadata();
assert!(f.contains(tskit::TableEqualityOptions::IGNORE_PROVENANCE));
assert!(f.contains(tskit::TableEqualityOptions::IGNORE_METADATA));
Implementations§
source§impl TableEqualityOptions
impl TableEqualityOptions
pub const IGNORE_METADATA: Self = _
pub const IGNORE_TS_METADATA: Self = _
pub const IGNORE_PROVENANCE: Self = _
pub const IGNORE_TIMESTAMPS: Self = _
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 TableEqualityOptions
impl TableEqualityOptions
sourcepub fn ignore_metadata(self) -> Self
pub fn ignore_metadata(self) -> Self
Set IGNORE_METADATA
sourcepub fn ignore_ts_metadata(self) -> Self
pub fn ignore_ts_metadata(self) -> Self
sourcepub fn ignore_provenance(self) -> Self
pub fn ignore_provenance(self) -> Self
sourcepub fn ignore_timestamps(self) -> Self
pub fn ignore_timestamps(self) -> Self
Trait Implementations§
source§impl Binary for TableEqualityOptions
impl Binary for TableEqualityOptions
source§impl BitAndAssign<TableEqualityOptions> for TableEqualityOptions
impl BitAndAssign<TableEqualityOptions> for TableEqualityOptions
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<TableEqualityOptions> for TableEqualityOptions
impl BitOr<TableEqualityOptions> for TableEqualityOptions
source§fn bitor(self, other: TableEqualityOptions) -> Self
fn bitor(self, other: TableEqualityOptions) -> Self
Returns the union of the two sets of flags.
§type Output = TableEqualityOptions
type Output = TableEqualityOptions
|
operator.source§impl BitOrAssign<TableEqualityOptions> for TableEqualityOptions
impl BitOrAssign<TableEqualityOptions> for TableEqualityOptions
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<TableEqualityOptions> for TableEqualityOptions
impl BitXorAssign<TableEqualityOptions> for TableEqualityOptions
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for TableEqualityOptions
impl Clone for TableEqualityOptions
source§fn clone(&self) -> TableEqualityOptions
fn clone(&self) -> TableEqualityOptions
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for TableEqualityOptions
impl Debug for TableEqualityOptions
source§impl Default for TableEqualityOptions
impl Default for TableEqualityOptions
source§fn default() -> TableEqualityOptions
fn default() -> TableEqualityOptions
source§impl Extend<TableEqualityOptions> for TableEqualityOptions
impl Extend<TableEqualityOptions> for TableEqualityOptions
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 TableEqualityOptions
impl From<u32> for TableEqualityOptions
source§impl FromIterator<TableEqualityOptions> for TableEqualityOptions
impl FromIterator<TableEqualityOptions> for TableEqualityOptions
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 TableEqualityOptions
impl Hash for TableEqualityOptions
source§impl LowerHex for TableEqualityOptions
impl LowerHex for TableEqualityOptions
source§impl Not for TableEqualityOptions
impl Not for TableEqualityOptions
source§impl Octal for TableEqualityOptions
impl Octal for TableEqualityOptions
source§impl Ord for TableEqualityOptions
impl Ord for TableEqualityOptions
source§fn cmp(&self, other: &TableEqualityOptions) -> Ordering
fn cmp(&self, other: &TableEqualityOptions) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<TableEqualityOptions> for TableEqualityOptions
impl PartialEq<TableEqualityOptions> for TableEqualityOptions
source§fn eq(&self, other: &TableEqualityOptions) -> bool
fn eq(&self, other: &TableEqualityOptions) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<TableEqualityOptions> for TableEqualityOptions
impl PartialOrd<TableEqualityOptions> for TableEqualityOptions
source§fn partial_cmp(&self, other: &TableEqualityOptions) -> Option<Ordering>
fn partial_cmp(&self, other: &TableEqualityOptions) -> 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<TableEqualityOptions> for TableEqualityOptions
impl SubAssign<TableEqualityOptions> for TableEqualityOptions
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.