Struct fidl_fuchsia_io::VmoFlags
source · pub struct VmoFlags { /* private fields */ }
Implementations§
source§impl VmoFlags
impl VmoFlags
sourcepub const PRIVATE_CLONE: Self = _
pub const PRIVATE_CLONE: Self = _
Require a copy-on-write clone of the underlying VMO. The request
should fail if the VMO cannot be cloned. May not be supplied
with SHARED_BUFFER
.
A private clone uses at least the guarantees of the
ZX_VMO_CHILD_SNAPSHOT_AT_LEAST_ON_WRITE
flag to
zx_vmo_create_child()
. This means that the returned VMO will
be copy-on-write (if WRITE
is requested) but that it may or
may not reflect subsequent content changes to the underlying
file. The returned VMO will not reflect size changes to the
file. These semantics match those of the POSIX mmap()
MAP_PRIVATE
flag.
In some cases, clients requiring a guaranteed snapshot of the
file can use SHARED_BUFFER
and then use
zx_vmo_create_child()
with ZX_VMO_CHILD_SNAPSHOT
. However,
in addition to cases where the implementation can’t return a
SHARED_BUFFER
, creating a full snapshot will fail if the VMO
is attached to the pager. Since most filesystems will use the
paging system, the full snapshot approach should only be used in
specific cases where the client is talking to a known server.
sourcepub const SHARED_BUFFER: Self = _
pub const SHARED_BUFFER: Self = _
Require a VMO that provides direct access to the contents of the
file’s underlying VMO. The request should fail if such a VMO
cannot be provided. May not be supplied with PRIVATE_CLONE
.
The returned VMO may not be resizable even when WRITE
access is
requested. In this case, [File.Resize
] should be used to resize
the file.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
source§impl VmoFlags
impl VmoFlags
pub fn has_unknown_bits(&self) -> bool
has_unknown_bits
pub fn get_unknown_bits(&self) -> u32
get_unknown_bits
Trait Implementations§
source§impl BitAndAssign<VmoFlags> for VmoFlags
impl BitAndAssign<VmoFlags> for VmoFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOrAssign<VmoFlags> for VmoFlags
impl BitOrAssign<VmoFlags> for VmoFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<VmoFlags> for VmoFlags
impl BitXorAssign<VmoFlags> for VmoFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Decode<VmoFlags> for VmoFlags
impl Decode<VmoFlags> for VmoFlags
source§impl Extend<VmoFlags> for VmoFlags
impl Extend<VmoFlags> for VmoFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<VmoFlags> for VmoFlags
impl FromIterator<VmoFlags> for VmoFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Ord for VmoFlags
impl Ord for VmoFlags
source§impl PartialEq<VmoFlags> for VmoFlags
impl PartialEq<VmoFlags> for VmoFlags
source§impl PartialOrd<VmoFlags> for VmoFlags
impl PartialOrd<VmoFlags> for VmoFlags
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 SubAssign<VmoFlags> for VmoFlags
impl SubAssign<VmoFlags> for VmoFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl TypeMarker for VmoFlags
impl TypeMarker for VmoFlags
source§fn inline_align(_context: Context) -> usize
fn inline_align(_context: Context) -> usize
source§fn inline_size(_context: Context) -> usize
fn inline_size(_context: Context) -> usize
inline_align
.§fn encode_is_copy() -> bool
fn encode_is_copy() -> bool
Self::Owned
matches the FIDL wire
format and encoding requires no validation. When true, we can optimize
encoding arrays and vectors of Self::Owned
to a single memcpy. Read more§fn decode_is_copy() -> bool
fn decode_is_copy() -> bool
Self::Owned
matches the FIDL wire
format and decoding requires no validation. When true, we can optimize
decoding arrays and vectors of Self::Owned
to a single memcpy.