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