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