Struct Vmo

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

Expand description

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 read(&self, data: &mut [u8], offset: u64) -> Result<usize, Status>

Read from a virtual memory object.

Wraps the zx_vmo_read syscall.

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

Write to a virtual memory object.

Wraps the zx_vmo_write syscall.

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 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 lookup( &self, offset: u64, size: u64, buffer: &mut [zx_paddr_t], ) -> Result<(), Status>

Look up a list of physical addresses corresponding to the pages held by the VMO from offset to offset+size, and store them in buffer.

Wraps the zx_vmo_op_range syscall with ZX_VMO_OP_LOOKUP.

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

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

Wraps the zx_vmo_clone syscall.

Trait Implementations§

impl AsHandleRef for Vmo

fn as_handle_ref(&self) -> HandleRef<'_>

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

fn raw_handle(&self) -> zx_handle_t

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: Time, ) -> Result<Signals, Status>

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.

impl Cookied for Vmo

fn get_cookie(&self, scope: &HandleRef<'_>) -> Result<u64, Status>

Get the cookie attached to this object, if any. Wraps the zx_object_get_cookie syscall.

fn set_cookie(&self, scope: &HandleRef<'_>, cookie: u64) -> Result<(), Status>

Attach an opaque cookie to this object with the given scope. The cookie may be read or changed in future only with the same scope. Wraps the zx_object_set_cookie syscall.

impl Debug for Vmo

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

Formats the value using the given formatter. Read more

impl From<Handle> for Vmo

fn from(handle: Handle) -> Self

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 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. Read more

fn into_raw(self) -> zx_handle_t

Converts the handle into it’s raw representation. Read more

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle. Read more

fn into_handle_based<H: HandleBased>(self) -> H

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

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

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

impl PartialEq for Vmo

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

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

1.0.0 · Source§

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

impl StructuralPartialEq for Vmo

Auto Trait Implementations§

impl Freeze for Vmo

impl RefUnwindSafe for Vmo

impl Send for Vmo

impl Sync for Vmo

impl Unpin for Vmo

impl UnwindSafe for Vmo

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.