Struct VmoFlags

pub struct VmoFlags(/* private fields */);

Implementations

impl VmoFlags

pub const READ: VmoFlags

Requests that the VMO be readable.

pub const WRITE: VmoFlags

Requests that the VMO be writable.

pub const EXECUTE: VmoFlags

Request that the VMO be executable.

pub const PRIVATE_CLONE: VmoFlags

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.

pub const SHARED_BUFFER: VmoFlags

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.

impl VmoFlags

pub const fn empty() -> VmoFlags

Get a flags value with all bits unset.

pub const fn all() -> VmoFlags

Get a flags value with all known bits set.

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<VmoFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> VmoFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> VmoFlags

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<VmoFlags>

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 is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: VmoFlags) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: VmoFlags) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: VmoFlags)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: VmoFlags)

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: VmoFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: VmoFlags, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: VmoFlags) -> VmoFlags

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: VmoFlags) -> VmoFlags

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: VmoFlags) -> VmoFlags

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: VmoFlags) -> VmoFlags

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> VmoFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl VmoFlags

pub const fn iter(&self) -> Iter<VmoFlags>

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<VmoFlags>

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.

impl VmoFlags

pub fn has_unknown_bits(&self) -> bool

👎Deprecated: Strict bits should not use has_unknown_bits

pub fn get_unknown_bits(&self) -> u32

👎Deprecated: Strict bits should not use get_unknown_bits

Trait Implementations

impl Binary for VmoFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl BitAnd for VmoFlags

fn bitand(self, other: VmoFlags) -> VmoFlags

The bitwise and (&) of the bits in two flags values.

type Output = VmoFlags

The resulting type after applying the & operator.

impl BitAndAssign for VmoFlags

fn bitand_assign(&mut self, other: VmoFlags)

The bitwise and (&) of the bits in two flags values.

impl BitOr for VmoFlags

fn bitor(self, other: VmoFlags) -> VmoFlags

The bitwise or (|) of the bits in two flags values.

type Output = VmoFlags

The resulting type after applying the | operator.

impl BitOrAssign for VmoFlags

fn bitor_assign(&mut self, other: VmoFlags)

The bitwise or (|) of the bits in two flags values.

impl BitXor for VmoFlags

fn bitxor(self, other: VmoFlags) -> VmoFlags

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = VmoFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for VmoFlags

fn bitxor_assign(&mut self, other: VmoFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for VmoFlags

fn clone(&self) -> VmoFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VmoFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<D> Decode<VmoFlags, D> for VmoFlags

where D: ResourceDialect,

fn new_empty() -> VmoFlags

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for VmoFlags

fn default() -> VmoFlags

Returns the “default value” for a type.

impl<D> Encode<VmoFlags, D> for VmoFlags

where D: ResourceDialect,

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl Extend<VmoFlags> for VmoFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = VmoFlags>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for VmoFlags

const FLAGS: &'static [Flag<VmoFlags>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> VmoFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<VmoFlags> for VmoFlags

fn from_iter<T>(iterator: T) -> VmoFlags

where T: IntoIterator<Item = VmoFlags>,

The bitwise or (|) of the bits in each flags value.

impl Hash for VmoFlags

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for VmoFlags

type Item = VmoFlags

The type of the elements being iterated over.

type IntoIter = Iter<VmoFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <VmoFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for VmoFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Not for VmoFlags

fn not(self) -> VmoFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = VmoFlags

The resulting type after applying the ! operator.

impl Octal for VmoFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Ord for VmoFlags

fn cmp(&self, other: &VmoFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for VmoFlags

fn eq(&self, other: &VmoFlags) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for VmoFlags

fn partial_cmp(&self, other: &VmoFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for VmoFlags

fn sub(self, other: VmoFlags) -> VmoFlags

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 = VmoFlags

The resulting type after applying the - operator.

impl SubAssign for VmoFlags

fn sub_assign(&mut self, other: VmoFlags)

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.

impl TypeMarker for VmoFlags

type Owned = VmoFlags

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of 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.

fn decode_is_copy() -> bool

Returns true if the memory layout of 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.

impl UpperHex for VmoFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl ValueTypeMarker for VmoFlags

type Borrowed<'a> = VmoFlags

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow( value: &<VmoFlags as TypeMarker>::Owned, ) -> <VmoFlags as ValueTypeMarker>::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Copy for VmoFlags

impl Eq for VmoFlags

impl StructuralPartialEq for VmoFlags