Struct sherwood::IteratorOptions
[-] [+]
[src]
pub struct IteratorOptions { // some fields omitted }
Iterator options
Methods
impl IteratorOptions
fn empty() -> IteratorOptions
Returns an empty set of flags.
fn all() -> IteratorOptions
Returns the set containing all flags.
fn bits(&self) -> u16
Returns the raw value of the flags currently stored.
fn from_bits(bits: u16) -> Option<IteratorOptions>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
fn from_bits_truncate(bits: u16) -> IteratorOptions
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
fn is_empty(&self) -> bool
Returns true
if no flags are currently stored.
fn is_all(&self) -> bool
Returns true
if all flags are currently set.
fn intersects(&self, other: IteratorOptions) -> bool
Returns true
if there are flags common to both self
and other
.
fn contains(&self, other: IteratorOptions) -> bool
Returns true
all of the flags in other
are contained within self
.
fn insert(&mut self, other: IteratorOptions)
Inserts the specified flags in-place.
fn remove(&mut self, other: IteratorOptions)
Removes the specified flags in-place.
fn toggle(&mut self, other: IteratorOptions)
Toggles the specified flags in-place.
Trait Implementations
impl BitOr for IteratorOptions
type Output = IteratorOptions
fn bitor(self, other: IteratorOptions) -> IteratorOptions
Returns the union of the two sets of flags.
impl BitXor for IteratorOptions
type Output = IteratorOptions
fn bitxor(self, other: IteratorOptions) -> IteratorOptions
Returns the left flags, but with all the right flags toggled.
impl BitAnd for IteratorOptions
type Output = IteratorOptions
fn bitand(self, other: IteratorOptions) -> IteratorOptions
Returns the intersection between the two sets of flags.
impl Sub for IteratorOptions
type Output = IteratorOptions
fn sub(self, other: IteratorOptions) -> IteratorOptions
Returns the set difference of the two sets of flags.
impl Not for IteratorOptions
type Output = IteratorOptions
fn not(self) -> IteratorOptions
Returns the complement of this set of flags.