Struct Bti 

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

An object representing a Zircon Bus Transaction Initiator object. See BTI Documentation for details.

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

Implementations

impl Bti

pub fn raw_handle(&self) -> u32

Return the handle’s integer value.

pub fn invalid() -> Bti

pub fn is_invalid(&self) -> bool

pub fn into_raw(self) -> u32

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

pub fn unowned(&self) -> Unowned<'_, Bti>

Returns an [Unowned] referring to this handle.

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

Returns a [HandleRef] referring to this handle.

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

Wraps the zx_handle_duplicate syscall.

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

Wraps the zx_handle_replace syscall.

pub fn into_handle(self) -> NullableHandle

Converts the value into its inner handle.

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.

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

Wraps the zx_object_wait_async syscall.

pub fn wait_item(&self, signals: Signals) -> WaitItem<'_>

Return a WaitItem for this handle and the provided signals to use with object_wait_many.

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

Wraps a call to the zx_object_get_property syscall for the ZX_PROP_NAME property.

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

Wraps a call to the zx_object_set_property syscall for the ZX_PROP_NAME property.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.

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

Returns the [Koid] for the object referred to by this handle.

impl Bti

pub fn create(iommu: &Iommu, id: u64) -> Result<Bti, Status>

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

Wraps the zx_object_get_info syscall for the ZX_INFO_BTI topic.

pub fn pin( &self, options: BtiOptions, vmo: &Vmo, offset: u64, size: u64, out_paddrs: &mut [usize], ) -> Result<Pmt, Status>

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

Releases all quarantined PMTs for the given BTI.

Wraps the zx_bti_release_quarantine system call.

Safety

The caller must ensure that the hardware is in a state where it is no longer attempting to access the memory unpinned by this call. Otherwise, without an IOMMU, this can cause arbitrary memory corruption.

Trait Implementations

impl AsHandleRef for Bti

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.

impl Debug for Bti

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

Formats the value using the given formatter.

impl Eq for Bti

impl From<Bti> for NullableHandle

fn from(x: Bti) -> NullableHandle

Converts to this type from the input type.

impl From<Handle> for Bti

fn from(handle: Handle) -> Bti

Converts to this type from the input type.

impl From<NullableHandle> for Bti

fn from(handle: NullableHandle) -> Bti

Converts to this type from the input type.

impl Hash for Bti

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 Bti

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Bti

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Bti

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

impl TryFrom<Bti> for Handle

type Error = Status

The type returned in the event of a conversion error.

fn try_from(x: Bti) -> Result<Handle, <Handle as TryFrom<Bti>>::Error>

Performs the conversion.