Struct tskit::TableSortOptions
source · #[repr(transparent)]pub struct TableSortOptions { /* private fields */ }
Expand description
Modify behavior of crate::TableCollection::sort
.
Examples
Default (empty) flags
let f = tskit::TableSortOptions::default();
assert_eq!(f, tskit::TableSortOptions::NONE);
Builder API
These methods can all be chained.
let f = tskit::TableSortOptions::default().no_check_integrity();
assert_eq!(f, tskit::TableSortOptions::NO_CHECK_INTEGRITY);
Implementations§
source§impl TableSortOptions
impl TableSortOptions
sourcepub const NO_CHECK_INTEGRITY: Self = _
pub const NO_CHECK_INTEGRITY: Self = _
Do not validate contents of edge table.
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 TableSortOptions
impl TableSortOptions
sourcepub fn no_check_integrity(self) -> Self
pub fn no_check_integrity(self) -> Self
Trait Implementations§
source§impl Binary for TableSortOptions
impl Binary for TableSortOptions
source§impl BitAnd<TableSortOptions> for TableSortOptions
impl BitAnd<TableSortOptions> for TableSortOptions
source§impl BitAndAssign<TableSortOptions> for TableSortOptions
impl BitAndAssign<TableSortOptions> for TableSortOptions
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<TableSortOptions> for TableSortOptions
impl BitOr<TableSortOptions> for TableSortOptions
source§fn bitor(self, other: TableSortOptions) -> Self
fn bitor(self, other: TableSortOptions) -> Self
Returns the union of the two sets of flags.
§type Output = TableSortOptions
type Output = TableSortOptions
|
operator.source§impl BitOrAssign<TableSortOptions> for TableSortOptions
impl BitOrAssign<TableSortOptions> for TableSortOptions
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<TableSortOptions> for TableSortOptions
impl BitXor<TableSortOptions> for TableSortOptions
source§impl BitXorAssign<TableSortOptions> for TableSortOptions
impl BitXorAssign<TableSortOptions> for TableSortOptions
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for TableSortOptions
impl Clone for TableSortOptions
source§fn clone(&self) -> TableSortOptions
fn clone(&self) -> TableSortOptions
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for TableSortOptions
impl Debug for TableSortOptions
source§impl Default for TableSortOptions
impl Default for TableSortOptions
source§fn default() -> TableSortOptions
fn default() -> TableSortOptions
source§impl Extend<TableSortOptions> for TableSortOptions
impl Extend<TableSortOptions> for TableSortOptions
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 TableSortOptions
impl From<u32> for TableSortOptions
source§impl FromIterator<TableSortOptions> for TableSortOptions
impl FromIterator<TableSortOptions> for TableSortOptions
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 TableSortOptions
impl Hash for TableSortOptions
source§impl LowerHex for TableSortOptions
impl LowerHex for TableSortOptions
source§impl Not for TableSortOptions
impl Not for TableSortOptions
source§impl Octal for TableSortOptions
impl Octal for TableSortOptions
source§impl Ord for TableSortOptions
impl Ord for TableSortOptions
source§fn cmp(&self, other: &TableSortOptions) -> Ordering
fn cmp(&self, other: &TableSortOptions) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<TableSortOptions> for TableSortOptions
impl PartialEq<TableSortOptions> for TableSortOptions
source§fn eq(&self, other: &TableSortOptions) -> bool
fn eq(&self, other: &TableSortOptions) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<TableSortOptions> for TableSortOptions
impl PartialOrd<TableSortOptions> for TableSortOptions
source§fn partial_cmp(&self, other: &TableSortOptions) -> Option<Ordering>
fn partial_cmp(&self, other: &TableSortOptions) -> 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 Sub<TableSortOptions> for TableSortOptions
impl Sub<TableSortOptions> for TableSortOptions
source§impl SubAssign<TableSortOptions> for TableSortOptions
impl SubAssign<TableSortOptions> for TableSortOptions
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.