Struct StreamOptions
pub struct StreamOptions(/* private fields */);
Implementations§
§impl StreamOptions
impl StreamOptions
pub const MODE_READ: StreamOptions
pub const MODE_WRITE: StreamOptions
pub const MODE_APPEND: StreamOptions
§impl StreamOptions
impl StreamOptions
pub const fn empty() -> StreamOptions
pub const fn empty() -> StreamOptions
Get a flags value with all bits unset.
pub const fn all() -> StreamOptions
pub const fn all() -> StreamOptions
Get a flags value with all known bits set.
pub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
pub const fn from_bits(bits: u32) -> Option<StreamOptions>
pub const fn from_bits(bits: u32) -> Option<StreamOptions>
Convert from a bits value.
This method will return None
if any unknown bits are set.
pub const fn from_bits_truncate(bits: u32) -> StreamOptions
pub const fn from_bits_truncate(bits: u32) -> StreamOptions
Convert from a bits value, unsetting any unknown bits.
pub const fn from_bits_retain(bits: u32) -> StreamOptions
pub const fn from_bits_retain(bits: u32) -> StreamOptions
Convert from a bits value exactly.
pub fn from_name(name: &str) -> Option<StreamOptions>
pub fn from_name(name: &str) -> Option<StreamOptions>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
pub const fn intersects(&self, other: StreamOptions) -> bool
pub const fn intersects(&self, other: StreamOptions) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
pub const fn contains(&self, other: StreamOptions) -> bool
pub const fn contains(&self, other: StreamOptions) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
pub fn insert(&mut self, other: StreamOptions)
pub fn insert(&mut self, other: StreamOptions)
The bitwise or (|
) of the bits in two flags values.
pub fn remove(&mut self, other: StreamOptions)
pub fn remove(&mut self, other: StreamOptions)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
pub fn toggle(&mut self, other: StreamOptions)
pub fn toggle(&mut self, other: StreamOptions)
The bitwise exclusive-or (^
) of the bits in two flags values.
pub fn set(&mut self, other: StreamOptions, value: bool)
pub fn set(&mut self, other: StreamOptions, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
pub const fn intersection(self, other: StreamOptions) -> StreamOptions
pub const fn intersection(self, other: StreamOptions) -> StreamOptions
The bitwise and (&
) of the bits in two flags values.
pub const fn union(self, other: StreamOptions) -> StreamOptions
pub const fn union(self, other: StreamOptions) -> StreamOptions
The bitwise or (|
) of the bits in two flags values.
pub const fn difference(self, other: StreamOptions) -> StreamOptions
pub const fn difference(self, other: StreamOptions) -> StreamOptions
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
pub const fn symmetric_difference(self, other: StreamOptions) -> StreamOptions
pub const fn symmetric_difference(self, other: StreamOptions) -> StreamOptions
The bitwise exclusive-or (^
) of the bits in two flags values.
pub const fn complement(self) -> StreamOptions
pub const fn complement(self) -> StreamOptions
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§impl StreamOptions
impl StreamOptions
pub const fn iter(&self) -> Iter<StreamOptions>
pub const fn iter(&self) -> Iter<StreamOptions>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
pub const fn iter_names(&self) -> IterNames<StreamOptions>
pub const fn iter_names(&self) -> IterNames<StreamOptions>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
§impl Binary for StreamOptions
impl Binary for StreamOptions
§impl BitAnd for StreamOptions
impl BitAnd for StreamOptions
§fn bitand(self, other: StreamOptions) -> StreamOptions
fn bitand(self, other: StreamOptions) -> StreamOptions
The bitwise and (&
) of the bits in two flags values.
§type Output = StreamOptions
type Output = StreamOptions
&
operator.§impl BitAndAssign for StreamOptions
impl BitAndAssign for StreamOptions
§fn bitand_assign(&mut self, other: StreamOptions)
fn bitand_assign(&mut self, other: StreamOptions)
The bitwise and (&
) of the bits in two flags values.
§impl BitOr for StreamOptions
impl BitOr for StreamOptions
§fn bitor(self, other: StreamOptions) -> StreamOptions
fn bitor(self, other: StreamOptions) -> StreamOptions
The bitwise or (|
) of the bits in two flags values.
§type Output = StreamOptions
type Output = StreamOptions
|
operator.§impl BitOrAssign for StreamOptions
impl BitOrAssign for StreamOptions
§fn bitor_assign(&mut self, other: StreamOptions)
fn bitor_assign(&mut self, other: StreamOptions)
The bitwise or (|
) of the bits in two flags values.
§impl BitXor for StreamOptions
impl BitXor for StreamOptions
§fn bitxor(self, other: StreamOptions) -> StreamOptions
fn bitxor(self, other: StreamOptions) -> StreamOptions
The bitwise exclusive-or (^
) of the bits in two flags values.
§type Output = StreamOptions
type Output = StreamOptions
^
operator.§impl BitXorAssign for StreamOptions
impl BitXorAssign for StreamOptions
§fn bitxor_assign(&mut self, other: StreamOptions)
fn bitxor_assign(&mut self, other: StreamOptions)
The bitwise exclusive-or (^
) of the bits in two flags values.
§impl Clone for StreamOptions
impl Clone for StreamOptions
§fn clone(&self) -> StreamOptions
fn clone(&self) -> StreamOptions
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for StreamOptions
impl Debug for StreamOptions
§impl Extend<StreamOptions> for StreamOptions
impl Extend<StreamOptions> for StreamOptions
§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = StreamOptions>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = StreamOptions>,
The bitwise or (|
) of the bits in each flags value.
Source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)§impl Flags for StreamOptions
impl Flags for StreamOptions
§const FLAGS: &'static [Flag<StreamOptions>]
const FLAGS: &'static [Flag<StreamOptions>]
§fn from_bits_retain(bits: u32) -> StreamOptions
fn from_bits_retain(bits: u32) -> StreamOptions
§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true
if any unknown bits are set.§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read more§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where
Self: Sized,
Flags::insert
] when value
is true
or [Flags::remove
] when value
is false
.§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read more§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.§impl FromIterator<StreamOptions> for StreamOptions
impl FromIterator<StreamOptions> for StreamOptions
§fn from_iter<T>(iterator: T) -> StreamOptionswhere
T: IntoIterator<Item = StreamOptions>,
fn from_iter<T>(iterator: T) -> StreamOptionswhere
T: IntoIterator<Item = StreamOptions>,
The bitwise or (|
) of the bits in each flags value.
§impl Hash for StreamOptions
impl Hash for StreamOptions
§impl IntoIterator for StreamOptions
impl IntoIterator for StreamOptions
§type Item = StreamOptions
type Item = StreamOptions
§type IntoIter = Iter<StreamOptions>
type IntoIter = Iter<StreamOptions>
§fn into_iter(self) -> <StreamOptions as IntoIterator>::IntoIter
fn into_iter(self) -> <StreamOptions as IntoIterator>::IntoIter
§impl LowerHex for StreamOptions
impl LowerHex for StreamOptions
§impl Not for StreamOptions
impl Not for StreamOptions
§fn not(self) -> StreamOptions
fn not(self) -> StreamOptions
The bitwise negation (!
) of the bits in a flags value, truncating the result.
§type Output = StreamOptions
type Output = StreamOptions
!
operator.§impl Octal for StreamOptions
impl Octal for StreamOptions
§impl Ord for StreamOptions
impl Ord for StreamOptions
§impl PartialEq for StreamOptions
impl PartialEq for StreamOptions
§impl PartialOrd for StreamOptions
impl PartialOrd for StreamOptions
§impl Sub for StreamOptions
impl Sub for StreamOptions
§fn sub(self, other: StreamOptions) -> StreamOptions
fn sub(self, other: StreamOptions) -> StreamOptions
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§type Output = StreamOptions
type Output = StreamOptions
-
operator.§impl SubAssign for StreamOptions
impl SubAssign for StreamOptions
§fn sub_assign(&mut self, other: StreamOptions)
fn sub_assign(&mut self, other: StreamOptions)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.