Struct tskit::TableClearOptions [−][src]
pub struct TableClearOptions { /* fields omitted */ }
Expand description
Modify behavior of crate::TableCollection::clear
.
Implementations
impl TableClearOptions
[src]
impl TableClearOptions
[src]pub const NONE: 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]
pub const fn empty() -> TableClearOptions
[src]Returns an empty set of flags
pub const fn all() -> TableClearOptions
[src]
pub const fn all() -> TableClearOptions
[src]Returns the set containing all flags.
pub const fn bits(&self) -> tsk_flags_t
[src]
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]
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]
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]
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 intersects(&self, other: TableClearOptions) -> bool
[src]
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]
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]
pub fn insert(&mut self, other: TableClearOptions)
[src]Inserts the specified flags in-place.
pub fn remove(&mut self, other: TableClearOptions)
[src]
pub fn remove(&mut self, other: TableClearOptions)
[src]Removes the specified flags in-place.
pub fn toggle(&mut self, other: TableClearOptions)
[src]
pub fn toggle(&mut self, other: TableClearOptions)
[src]Toggles the specified flags in-place.
pub fn set(&mut self, other: TableClearOptions, value: bool)
[src]
pub fn set(&mut self, other: TableClearOptions, value: bool)
[src]Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl Binary for TableClearOptions
[src]
impl Binary for TableClearOptions
[src]impl BitAnd<TableClearOptions> for TableClearOptions
[src]
impl BitAnd<TableClearOptions> for TableClearOptions
[src]fn bitand(self, other: TableClearOptions) -> TableClearOptions
[src]
fn bitand(self, other: TableClearOptions) -> TableClearOptions
[src]Returns the intersection between the two sets of flags.
type Output = TableClearOptions
type Output = TableClearOptions
The resulting type after applying the &
operator.
impl BitAndAssign<TableClearOptions> for TableClearOptions
[src]
impl BitAndAssign<TableClearOptions> for TableClearOptions
[src]fn bitand_assign(&mut self, other: 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]fn bitor(self, other: TableClearOptions) -> TableClearOptions
[src]
fn bitor(self, other: TableClearOptions) -> TableClearOptions
[src]Returns the union of the two sets of flags.
type Output = TableClearOptions
type Output = TableClearOptions
The resulting type after applying the |
operator.
impl BitOrAssign<TableClearOptions> for TableClearOptions
[src]
impl BitOrAssign<TableClearOptions> for TableClearOptions
[src]fn bitor_assign(&mut self, other: 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]fn bitxor(self, other: TableClearOptions) -> TableClearOptions
[src]
fn bitxor(self, other: TableClearOptions) -> TableClearOptions
[src]Returns the left flags, but with all the right flags toggled.
type Output = TableClearOptions
type Output = TableClearOptions
The resulting type after applying the ^
operator.
impl BitXorAssign<TableClearOptions> for TableClearOptions
[src]
impl BitXorAssign<TableClearOptions> for TableClearOptions
[src]fn bitxor_assign(&mut self, other: 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]
fn clone(&self) -> TableClearOptions
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for TableClearOptions
[src]
impl Debug for TableClearOptions
[src]impl Default for TableClearOptions
[src]
impl Default for TableClearOptions
[src]fn default() -> TableClearOptions
[src]
fn default() -> TableClearOptions
[src]Returns the “default value” for a type. Read more
impl Extend<TableClearOptions> for TableClearOptions
[src]
impl Extend<TableClearOptions> for TableClearOptions
[src]fn extend<T: IntoIterator<Item = TableClearOptions>>(&mut self, iterator: T)
[src]
fn extend<T: IntoIterator<Item = TableClearOptions>>(&mut self, iterator: T)
[src]Extends a collection with the contents of an iterator. Read more
fn extend_one(&mut self, item: A)
[src]
fn extend_one(&mut self, item: A)
[src]extend_one
)Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl FromIterator<TableClearOptions> for TableClearOptions
[src]
impl FromIterator<TableClearOptions> for TableClearOptions
[src]fn from_iter<T: IntoIterator<Item = TableClearOptions>>(
iterator: T
) -> TableClearOptions
[src]
fn from_iter<T: IntoIterator<Item = TableClearOptions>>(
iterator: T
) -> TableClearOptions
[src]Creates a value from an iterator. Read more
impl Hash for TableClearOptions
[src]
impl Hash for TableClearOptions
[src]impl LowerHex for TableClearOptions
[src]
impl LowerHex for TableClearOptions
[src]impl Not for TableClearOptions
[src]
impl Not for TableClearOptions
[src]fn not(self) -> TableClearOptions
[src]
fn not(self) -> TableClearOptions
[src]Returns the complement of this set of flags.
type Output = TableClearOptions
type Output = TableClearOptions
The resulting type after applying the !
operator.
impl Octal for TableClearOptions
[src]
impl Octal for TableClearOptions
[src]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 eq(&self, other: &TableClearOptions) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &TableClearOptions) -> bool
[src]
fn ne(&self, other: &TableClearOptions) -> bool
[src]This method tests for !=
.
impl PartialOrd<TableClearOptions> for TableClearOptions
[src]
impl PartialOrd<TableClearOptions> for TableClearOptions
[src]fn partial_cmp(&self, other: &TableClearOptions) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &TableClearOptions) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Sub<TableClearOptions> for TableClearOptions
[src]
impl Sub<TableClearOptions> for TableClearOptions
[src]fn sub(self, other: TableClearOptions) -> TableClearOptions
[src]
fn sub(self, other: TableClearOptions) -> TableClearOptions
[src]Returns the set difference of the two sets of flags.
type Output = TableClearOptions
type Output = TableClearOptions
The resulting type after applying the -
operator.
impl SubAssign<TableClearOptions> for TableClearOptions
[src]
impl SubAssign<TableClearOptions> for TableClearOptions
[src]fn sub_assign(&mut self, other: TableClearOptions)
[src]
fn sub_assign(&mut self, other: TableClearOptions)
[src]Disables all flags enabled in the set.
impl UpperHex for TableClearOptions
[src]
impl UpperHex for TableClearOptions
[src]impl Copy for TableClearOptions
[src]
impl Eq for TableClearOptions
[src]
impl StructuralEq for TableClearOptions
[src]
impl StructuralPartialEq for TableClearOptions
[src]
Auto Trait Implementations
impl RefUnwindSafe for TableClearOptions
impl Send for TableClearOptions
impl Sync for TableClearOptions
impl Unpin for TableClearOptions
impl UnwindSafe for TableClearOptions
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more