Struct rustix::fs::CopyfileFlags
source · #[repr(transparent)]pub struct CopyfileFlags(/* private fields */);
Expand description
COPYFILE_*
constants for use with fcopyfile
.
Implementations§
source§impl CopyfileFlags
impl CopyfileFlags
source§impl CopyfileFlags
impl CopyfileFlags
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 CopyfileFlags
impl CopyfileFlags
sourcepub const fn iter(&self) -> Iter<CopyfileFlags>
pub const fn iter(&self) -> Iter<CopyfileFlags>
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<CopyfileFlags>
pub const fn iter_names(&self) -> IterNames<CopyfileFlags>
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 CopyfileFlags
impl Binary for CopyfileFlags
source§impl BitAnd<CopyfileFlags> for CopyfileFlags
impl BitAnd<CopyfileFlags> for CopyfileFlags
source§impl BitAndAssign<CopyfileFlags> for CopyfileFlags
impl BitAndAssign<CopyfileFlags> for CopyfileFlags
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<CopyfileFlags> for CopyfileFlags
impl BitOr<CopyfileFlags> for CopyfileFlags
source§fn bitor(self, other: CopyfileFlags) -> Self
fn bitor(self, other: CopyfileFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = CopyfileFlags
type Output = CopyfileFlags
|
operator.source§impl BitOrAssign<CopyfileFlags> for CopyfileFlags
impl BitOrAssign<CopyfileFlags> for CopyfileFlags
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<CopyfileFlags> for CopyfileFlags
impl BitXor<CopyfileFlags> for CopyfileFlags
source§impl BitXorAssign<CopyfileFlags> for CopyfileFlags
impl BitXorAssign<CopyfileFlags> for CopyfileFlags
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 CopyfileFlags
impl Clone for CopyfileFlags
source§fn clone(&self) -> CopyfileFlags
fn clone(&self) -> CopyfileFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CopyfileFlags
impl Debug for CopyfileFlags
source§impl Extend<CopyfileFlags> for CopyfileFlags
impl Extend<CopyfileFlags> for CopyfileFlags
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 CopyfileFlags
impl Flags for CopyfileFlags
source§const FLAGS: &'static [Flag<CopyfileFlags>] = _
const FLAGS: &'static [Flag<CopyfileFlags>] = _
source§fn from_bits_retain(bits: c_uint) -> CopyfileFlags
fn from_bits_retain(bits: c_uint) -> CopyfileFlags
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<CopyfileFlags> for CopyfileFlags
impl FromIterator<CopyfileFlags> for CopyfileFlags
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 CopyfileFlags
impl Hash for CopyfileFlags
source§impl IntoIterator for CopyfileFlags
impl IntoIterator for CopyfileFlags
source§impl LowerHex for CopyfileFlags
impl LowerHex for CopyfileFlags
source§impl Not for CopyfileFlags
impl Not for CopyfileFlags
source§impl Octal for CopyfileFlags
impl Octal for CopyfileFlags
source§impl PartialEq<CopyfileFlags> for CopyfileFlags
impl PartialEq<CopyfileFlags> for CopyfileFlags
source§fn eq(&self, other: &CopyfileFlags) -> bool
fn eq(&self, other: &CopyfileFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for CopyfileFlags
impl PublicFlags for CopyfileFlags
source§impl Sub<CopyfileFlags> for CopyfileFlags
impl Sub<CopyfileFlags> for CopyfileFlags
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.
§type Output = CopyfileFlags
type Output = CopyfileFlags
-
operator.source§impl SubAssign<CopyfileFlags> for CopyfileFlags
impl SubAssign<CopyfileFlags> for CopyfileFlags
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.