Struct Pmt 

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

An object representing a Zircon Pinned Memory Token. See PMT Documentation for details.

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

Implementations

impl Pmt

pub fn into_raw(self) -> u32

Return the raw handle’s integer value without closing it when self is dropped.

pub fn duplicate(&self, rights: Rights) -> Result<Pmt, Status>

Wraps the zx_handle_duplicate syscall.

pub fn replace(self, rights: Rights) -> Result<Pmt, Status>

Wraps the zx_handle_replace syscall.

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

Wraps the zx_object_signal syscall.

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

Wraps the zx_object_wait_one syscall.

impl Pmt

pub unsafe fn unpin(self) -> Result<(), Status>

Unpins a Pinned Memory Token. Wraps the zx_pmt_unpin system call to unpin a pmt.

This function is marked unsafe because calling it at the wrong time (i.e., while hardware is still accessing the pinned memory) can lead to memory corruption.

Safety

The caller must ensure hardware is no longer accessing the memory that has been pinned or else risk arbitrary memory corruption. It is strongly recommended you do not call this in a drop method.

Trait Implementations

impl AsHandleRef for Pmt

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

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 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<Pmt> for Pmt

Available on crate feature fuchsia only.

fn compat_from(value: Pmt) -> Pmt

Converts value into a value of this type.

impl Debug for Pmt

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

Formats the value using the given formatter.

impl<E> Encode<WirePmt, E> for Pmt

where E: HandleEncoder + ?Sized,

fn encode( self, encoder: &mut E, out: &mut MaybeUninit<WirePmt>, constraint: <WirePmt as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this value into an encoder and output.

const COPY_OPTIMIZATION: CopyOptimization<Self, W> = _

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

impl<E> EncodeOption<WireOptionalPmt, E> for Pmt

where E: HandleEncoder + ?Sized,

fn encode_option( this: Option<Pmt>, encoder: &mut E, out: &mut MaybeUninit<WireOptionalPmt>, constraint: (), ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl From<NullableHandle> for Pmt

fn from(handle: NullableHandle) -> Pmt

Converts to this type from the input type.

impl From<Pmt> for NullableHandle

fn from(x: Pmt) -> NullableHandle

Converts to this type from the input type.

impl FromWire<WirePmt> for Pmt

fn from_wire(wire: WirePmt) -> Pmt

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<WireOptionalPmt> for Pmt

fn from_wire_option(wire: WireOptionalPmt) -> Option<Pmt>

Converts the given wire to an option of this type.

impl HandleBased for Pmt

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) -> NullableHandle

Converts the value into its inner handle.

fn into_raw(self) -> u32

Converts the handle into it’s raw representation.

fn from_handle(handle: NullableHandle) -> 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 Pmt

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 Pmt

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

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

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

impl StructuralPartialEq for Pmt