Struct wasi::filesystem::types::DescriptorFlags
source · pub struct DescriptorFlags(/* private fields */);
Expand description
Descriptor flags.
Note: This was called fdflags
in earlier versions of WASI.
Implementations§
source§impl DescriptorFlags
impl DescriptorFlags
sourcepub const FILE_INTEGRITY_SYNC: Self = _
pub const FILE_INTEGRITY_SYNC: Self = _
Request that writes be performed according to synchronized I/O file
integrity completion. The data stored in the file and the file’s
metadata are synchronized. This is similar to O_SYNC
in POSIX.
The precise semantics of this operation have not yet been defined for WASI. At this time, it should be interpreted as a request, and not a requirement.
sourcepub const DATA_INTEGRITY_SYNC: Self = _
pub const DATA_INTEGRITY_SYNC: Self = _
Request that writes be performed according to synchronized I/O data
integrity completion. Only the data stored in the file is
synchronized. This is similar to O_DSYNC
in POSIX.
The precise semantics of this operation have not yet been defined for WASI. At this time, it should be interpreted as a request, and not a requirement.
sourcepub const REQUESTED_WRITE_SYNC: Self = _
pub const REQUESTED_WRITE_SYNC: Self = _
Requests that reads be performed at the same level of integrety
requested for writes. This is similar to O_RSYNC
in POSIX.
The precise semantics of this operation have not yet been defined for WASI. At this time, it should be interpreted as a request, and not a requirement.
sourcepub const MUTATE_DIRECTORY: Self = _
pub const MUTATE_DIRECTORY: Self = _
Mutating directories mode: Directory contents may be mutated.
When this flag is unset on a descriptor, operations using the
descriptor which would create, rename, delete, modify the data or
metadata of filesystem objects, or obtain another handle which
would permit any of those, shall fail with error-code::read-only
if
they would otherwise succeed.
This may only be set on directories.
source§impl DescriptorFlags
impl DescriptorFlags
sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> 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: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> Self
pub const fn from_bits_retain(bits: u8) -> 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 DescriptorFlags
impl DescriptorFlags
sourcepub const fn iter(&self) -> Iter<DescriptorFlags>
pub const fn iter(&self) -> Iter<DescriptorFlags>
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<DescriptorFlags>
pub const fn iter_names(&self) -> IterNames<DescriptorFlags>
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 DescriptorFlags
impl Binary for DescriptorFlags
source§impl BitAnd for DescriptorFlags
impl BitAnd for DescriptorFlags
source§impl BitAndAssign for DescriptorFlags
impl BitAndAssign for DescriptorFlags
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 DescriptorFlags
impl BitOr for DescriptorFlags
source§fn bitor(self, other: DescriptorFlags) -> Self
fn bitor(self, other: DescriptorFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = DescriptorFlags
type Output = DescriptorFlags
|
operator.source§impl BitOrAssign for DescriptorFlags
impl BitOrAssign for DescriptorFlags
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 DescriptorFlags
impl BitXor for DescriptorFlags
source§impl BitXorAssign for DescriptorFlags
impl BitXorAssign for DescriptorFlags
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 DescriptorFlags
impl Clone for DescriptorFlags
source§fn clone(&self) -> DescriptorFlags
fn clone(&self) -> DescriptorFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DescriptorFlags
impl Debug for DescriptorFlags
source§impl Extend<DescriptorFlags> for DescriptorFlags
impl Extend<DescriptorFlags> for DescriptorFlags
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 DescriptorFlags
impl Flags for DescriptorFlags
source§const FLAGS: &'static [Flag<DescriptorFlags>] = _
const FLAGS: &'static [Flag<DescriptorFlags>] = _
source§fn from_bits_retain(bits: u8) -> DescriptorFlags
fn from_bits_retain(bits: u8) -> DescriptorFlags
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<DescriptorFlags> for DescriptorFlags
impl FromIterator<DescriptorFlags> for DescriptorFlags
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 DescriptorFlags
impl Hash for DescriptorFlags
source§impl IntoIterator for DescriptorFlags
impl IntoIterator for DescriptorFlags
source§impl LowerHex for DescriptorFlags
impl LowerHex for DescriptorFlags
source§impl Not for DescriptorFlags
impl Not for DescriptorFlags
source§impl Octal for DescriptorFlags
impl Octal for DescriptorFlags
source§impl Ord for DescriptorFlags
impl Ord for DescriptorFlags
source§fn cmp(&self, other: &DescriptorFlags) -> Ordering
fn cmp(&self, other: &DescriptorFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for DescriptorFlags
impl PartialEq for DescriptorFlags
source§fn eq(&self, other: &DescriptorFlags) -> bool
fn eq(&self, other: &DescriptorFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for DescriptorFlags
impl PartialOrd for DescriptorFlags
source§fn partial_cmp(&self, other: &DescriptorFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &DescriptorFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PublicFlags for DescriptorFlags
impl PublicFlags for DescriptorFlags
source§impl Sub for DescriptorFlags
impl Sub for DescriptorFlags
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 = DescriptorFlags
type Output = DescriptorFlags
-
operator.source§impl SubAssign for DescriptorFlags
impl SubAssign for DescriptorFlags
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.