Struct Vmo 

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

An object representing a Zircon virtual memory object.

As essentially a subtype of Handle, it can be freely interconverted.

Implementations

impl Vmo

pub fn create(size: u64) -> Result<Vmo, Status>

Create a virtual memory object.

Wraps the zx_vmo_create syscall. See the Shared Memory: Virtual Memory Objects (VMOs) for more information.

pub fn create_with_opts(opts: VmoOptions, size: u64) -> Result<Vmo, Status>

Create a virtual memory object with options.

Wraps the zx_vmo_create syscall, allowing options to be passed.

pub fn create_contiguous( bti: &Bti, size: usize, alignment_log2: u32, ) -> Result<Vmo, Status>

Create a physically contiguous virtual memory object.

Wraps the zx_vmo_create_contiguous syscall.

pub fn read(&self, data: &mut [u8], offset: u64) -> Result<(), Status>

Read from a virtual memory object.

Wraps the zx_vmo_read syscall.

pub unsafe fn read_raw<T>( &self, buffer: *mut T, buffer_length: usize, offset: u64, ) -> Result<(), Status>

where T: FromBytes,

Provides a very thin wrapper over zx_vmo_read.

Safety

Callers must guarantee that the buffer is valid to write to.

pub fn read_uninit<'a, T>( &self, data: &'a mut [MaybeUninit<T>], offset: u64, ) -> Result<&'a mut [T], Status>

where T: Copy + FromBytes,

Same as read, but reads into memory that might not be initialized, returning an initialized slice of bytes on success.

Copy is required to ensure that there are no custom Drop implementations. It is difficult to correctly run custom drop code after initializing a MaybeUninit.

pub fn read_to_vec<T>(&self, offset: u64, length: u64) -> Result<Vec<T>, Status>

where T: Copy + FromBytes,

Same as read, but returns a Vec.

pub fn read_to_array<T, const N: usize>( &self, offset: u64, ) -> Result<[T; N], Status>

where T: Copy + FromBytes,

Same as read, but returns an array.

pub fn read_to_object<T>(&self, offset: u64) -> Result<T, Status>

where T: Copy + FromBytes,

Same as read, but returns a T.

pub fn write(&self, data: &[u8], offset: u64) -> Result<(), Status>

Write to a virtual memory object.

Wraps the zx_vmo_write syscall.

pub fn transfer_data( &self, options: TransferDataOptions, offset: u64, length: u64, src_vmo: &Vmo, src_offset: u64, ) -> Result<(), Status>

Efficiently transfers data from one VMO to another.

pub fn get_size(&self) -> Result<u64, Status>

Get the size of a virtual memory object.

Wraps the zx_vmo_get_size syscall.

pub fn set_size(&self, size: u64) -> Result<(), Status>

Attempt to change the size of a virtual memory object.

Wraps the zx_vmo_set_size syscall.

pub fn get_stream_size(&self) -> Result<u64, Status>

Get the stream size of a virtual memory object.

Wraps the zx_vmo_get_stream_size syscall.

pub fn set_stream_size(&self, size: u64) -> Result<(), Status>

Attempt to set the stream size of a virtual memory object.

Wraps the zx_vmo_set_stream_size syscall.

pub fn set_cache_policy(&self, cache_policy: CachePolicy) -> Result<(), Status>

Attempt to change the cache policy of a virtual memory object.

Wraps the zx_vmo_set_cache_policy syscall.

pub fn op_range(&self, op: VmoOp, offset: u64, size: u64) -> Result<(), Status>

Perform an operation on a range of a virtual memory object.

Wraps the zx_vmo_op_range syscall.

pub fn info(&self) -> Result<VmoInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_VMO topic.

pub fn create_child( &self, opts: VmoChildOptions, offset: u64, size: u64, ) -> Result<Vmo, Status>

Create a new virtual memory object that clones a range of this one.

Wraps the zx_vmo_create_child syscall.

pub fn replace_as_executable(self, vmex: &Resource) -> Result<Vmo, Status>

Replace a VMO, adding execute rights.

Wraps the zx_vmo_replace_as_executable syscall.

impl Vmo

pub fn get_content_size(&self) -> Result<u64, Status>

impl Vmo

pub fn set_content_size(&self, val: &u64) -> Result<(), Status>

Trait Implementations

impl AsHandleRef for Vmo

fn as_handle_ref(&self) -> Unowned<'_, Handle>

Get a reference to the handle. One important use of such a reference is for object_wait_many.

fn raw_handle(&self) -> u32

Interpret the reference as a raw handle (an integer type). Two distinct handles will have different raw values (so it can perhaps be used as a key in a data structure).

fn signal_handle( &self, clear_mask: Signals, set_mask: Signals, ) -> Result<(), Status>

Set and clear userspace-accessible signal bits on an object. Wraps the zx_object_signal syscall.

fn wait_handle( &self, signals: Signals, deadline: Instant<MonotonicTimeline>, ) -> WaitResult

Waits on a handle. Wraps the zx_object_wait_one syscall.

fn wait_async_handle( &self, port: &Port, key: u64, signals: Signals, options: WaitAsyncOpts, ) -> Result<(), Status>

Causes packet delivery on the given port when the object changes state and matches signals. zx_object_wait_async syscall.

fn get_name(&self) -> Result<Name, Status>

Get the Property::NAME property for this object.

fn set_name(&self, name: &Name) -> Result<(), Status>

Set the Property::NAME property for this object.

fn basic_info(&self) -> Result<HandleBasicInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.

fn count_info(&self) -> Result<HandleCountInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.

fn get_koid(&self) -> Result<Koid, Status>

Returns the koid (kernel object ID) for this handle.

impl CompatFrom<Vmo> for Vmo

fn compat_from(value: Vmo) -> Vmo

Converts value into a value of this type.

impl Debug for Vmo

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

Formats the value using the given formatter.

impl Encodable for Vmo

type Encoded = WireVmo

The wire type for the value.

const COPY_OPTIMIZATION: CopyOptimization<Self, Self::Encoded> = _

Whether the conversion from Self to Self::Encoded is equivalent to copying the raw bytes of Self.

impl EncodableOption for Vmo

type EncodedOption = WireOptionalVmo

The wire type for the optional value.

impl<E> Encode<E> for Vmo

where E: HandleEncoder + ?Sized,

fn encode( self, encoder: &mut E, out: &mut MaybeUninit<<Vmo as Encodable>::Encoded>, ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.

impl<E> EncodeOption<E> for Vmo

where E: HandleEncoder + ?Sized,

fn encode_option( this: Option<Vmo>, encoder: &mut E, out: &mut MaybeUninit<<Vmo as EncodableOption>::EncodedOption>, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl From<Handle> for Vmo

fn from(handle: Handle) -> Vmo

Converts to this type from the input type.

impl From<Vmo> for Handle

fn from(x: Vmo) -> Handle

Converts to this type from the input type.

impl FromWire<WireVmo> for Vmo

fn from_wire(wire: WireVmo) -> Vmo

Converts the given wire to this type.

const COPY_OPTIMIZATION: CopyOptimization<W, Self> = _

Whether the conversion from W to Self is equivalent to copying the raw bytes of W.

impl FromWireOption<WireOptionalVmo> for Vmo

fn from_wire_option(wire: WireOptionalVmo) -> Option<Vmo>

Converts the given wire to an option of this type.

impl HandleBased for Vmo

fn duplicate_handle(&self, rights: Rights) -> Result<Self, Status>

Duplicate a handle, possibly reducing the rights available. Wraps the zx_handle_duplicate syscall.

fn replace_handle(self, rights: Rights) -> Result<Self, Status>

Create a replacement for a handle, possibly reducing the rights available. This invalidates the original handle. Wraps the zx_handle_replace syscall.

fn into_handle(self) -> Handle

Converts the value into its inner handle.

fn into_raw(self) -> u32

Converts the handle into it’s raw representation.

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle.

fn into_handle_based<H>(self) -> H

where H: HandleBased,

Creates an instance of another handle-based type from this value’s inner handle.

fn from_handle_based<H>(h: H) -> Self

where H: HandleBased,

Creates an instance of this type from the inner handle of another handle-based type.

fn is_invalid_handle(&self) -> bool

impl Hash for Vmo

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 Ord for Vmo

fn cmp(&self, other: &Vmo) -> 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 Vmo

fn eq(&self, other: &Vmo) -> 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 Vmo

fn partial_cmp(&self, other: &Vmo) -> 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 Eq for Vmo

impl StructuralPartialEq for Vmo