Struct fuchsia_zircon::Vmo

source ·
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§

source§

impl Vmo

source

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.

source

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.

source

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.

source

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

Read from a virtual memory object.

Wraps the zx_vmo_read syscall.

source

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

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

source

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

Same as read, but returns a Vec.

source

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

Same as read, but returns an array.

source

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

Same as read, but returns a T.

source

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

Write to a virtual memory object.

Wraps the zx_vmo_write syscall.

source

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.

source

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

Get the size of a virtual memory object.

Wraps the zx_vmo_get_size syscall.

source

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.

source

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.

source

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.

source

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

Wraps the zx_object_get_info syscall for the ZX_INFO_VMO topic.

source

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.

source

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.

source§

impl Vmo

source§

impl Vmo

source

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

Trait Implementations§

source§

impl AsHandleRef for Vmo

source§

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

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

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).
source§

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.
source§

fn wait_handle( &self, signals: Signals, deadline: Time ) -> Result<Signals, Status>

Waits on a handle. Wraps the zx_object_wait_one syscall.
source§

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.
source§

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

Get the Property::NAME property for this object. Read more
source§

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

Set the Property::NAME property for this object. Read more
source§

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.
source§

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.
source§

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

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

impl Debug for Vmo

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Handle> for Vmo

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Vmo> for Handle

source§

fn from(x: Vmo) -> Handle

Converts to this type from the input type.
source§

impl HandleBased for Vmo

source§

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

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

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.
source§

fn into_handle(self) -> Handle

Converts the value into its inner handle. Read more
source§

fn into_raw(self) -> zx_handle_t

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

fn from_handle(handle: Handle) -> Self

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

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

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

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

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

fn is_invalid_handle(&self) -> bool

source§

impl Hash for Vmo

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Vmo

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Vmo

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for Vmo

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Eq for Vmo

source§

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§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.