Struct rustix::io::ReadWriteFlags
source · pub struct ReadWriteFlags(/* private fields */);
Implementations§
source§impl ReadWriteFlags
impl ReadWriteFlags
sourcepub const fn bits(&self) -> c_uint
pub const fn bits(&self) -> c_uint
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: c_uint) -> Option<Self>
pub const fn from_bits(bits: c_uint) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: c_uint) -> Self
pub const fn from_bits_truncate(bits: c_uint) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: c_uint) -> Self
pub const fn from_bits_retain(bits: c_uint) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
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.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl ReadWriteFlags
impl ReadWriteFlags
sourcepub const fn iter(&self) -> Iter<ReadWriteFlags>
pub const fn iter(&self) -> Iter<ReadWriteFlags>
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.
sourcepub const fn iter_names(&self) -> IterNames<ReadWriteFlags>
pub const fn iter_names(&self) -> IterNames<ReadWriteFlags>
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§
source§impl Binary for ReadWriteFlags
impl Binary for ReadWriteFlags
source§impl BitAnd for ReadWriteFlags
impl BitAnd for ReadWriteFlags
source§impl BitAndAssign for ReadWriteFlags
impl BitAndAssign for ReadWriteFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for ReadWriteFlags
impl BitOr for ReadWriteFlags
source§fn bitor(self, other: ReadWriteFlags) -> Self
fn bitor(self, other: ReadWriteFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
source§type Output = ReadWriteFlags
type Output = ReadWriteFlags
|
operator.source§impl BitOrAssign for ReadWriteFlags
impl BitOrAssign for ReadWriteFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for ReadWriteFlags
impl BitXor for ReadWriteFlags
source§impl BitXorAssign for ReadWriteFlags
impl BitXorAssign for ReadWriteFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for ReadWriteFlags
impl Clone for ReadWriteFlags
source§fn clone(&self) -> ReadWriteFlags
fn clone(&self) -> ReadWriteFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ReadWriteFlags
impl Debug for ReadWriteFlags
source§impl Extend<ReadWriteFlags> for ReadWriteFlags
impl Extend<ReadWriteFlags> for ReadWriteFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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
)source§impl Flags for ReadWriteFlags
impl Flags for ReadWriteFlags
source§const FLAGS: &'static [Flag<ReadWriteFlags>] = _
const FLAGS: &'static [Flag<ReadWriteFlags>] = _
source§fn from_bits_retain(bits: c_uint) -> ReadWriteFlags
fn from_bits_retain(bits: c_uint) -> ReadWriteFlags
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§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.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§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.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<ReadWriteFlags> for ReadWriteFlags
impl FromIterator<ReadWriteFlags> for ReadWriteFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for ReadWriteFlags
impl Hash for ReadWriteFlags
source§impl IntoIterator for ReadWriteFlags
impl IntoIterator for ReadWriteFlags
source§impl LowerHex for ReadWriteFlags
impl LowerHex for ReadWriteFlags
source§impl Not for ReadWriteFlags
impl Not for ReadWriteFlags
source§impl Octal for ReadWriteFlags
impl Octal for ReadWriteFlags
source§impl PartialEq for ReadWriteFlags
impl PartialEq for ReadWriteFlags
source§impl PublicFlags for ReadWriteFlags
impl PublicFlags for ReadWriteFlags
source§impl Sub for ReadWriteFlags
impl Sub for ReadWriteFlags
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
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.
source§type Output = ReadWriteFlags
type Output = ReadWriteFlags
-
operator.source§impl SubAssign for ReadWriteFlags
impl SubAssign for ReadWriteFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
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.
source§impl UpperHex for ReadWriteFlags
impl UpperHex for ReadWriteFlags
impl Copy for ReadWriteFlags
impl Eq for ReadWriteFlags
impl StructuralPartialEq for ReadWriteFlags
Auto Trait Implementations§
impl Freeze for ReadWriteFlags
impl RefUnwindSafe for ReadWriteFlags
impl Send for ReadWriteFlags
impl Sync for ReadWriteFlags
impl Unpin for ReadWriteFlags
impl UnwindSafe for ReadWriteFlags
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)