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