Trait fidl::handle::fuchsia_handles::HandleBased
source · pub trait HandleBased: AsHandleRef + From<Handle> + Into<Handle> {
// Provided methods
fn duplicate_handle(&self, rights: Rights) -> Result<Self, Status> { ... }
fn replace_handle(self, rights: Rights) -> Result<Self, Status> { ... }
fn into_handle(self) -> Handle { ... }
fn into_raw(self) -> u32 { ... }
fn from_handle(handle: Handle) -> Self { ... }
fn into_handle_based<H>(self) -> H
where H: HandleBased { ... }
fn from_handle_based<H>(h: H) -> Self
where H: HandleBased { ... }
fn is_invalid_handle(&self) -> bool { ... }
}Expand description
A trait implemented by all handle-based types.
Note: it is reasonable for user-defined objects wrapping a handle to implement
this trait. For example, a specific interface in some protocol might be
represented as a newtype of Channel, and implement the as_handle_ref
method and the From<Handle> trait to facilitate conversion from and to the
interface.
Provided Methods§
sourcefn duplicate_handle(&self, rights: Rights) -> Result<Self, Status>
fn duplicate_handle(&self, rights: Rights) -> Result<Self, Status>
Duplicate a handle, possibly reducing the rights available. Wraps the zx_handle_duplicate syscall.
sourcefn replace_handle(self, rights: Rights) -> Result<Self, Status>
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.
sourcefn into_handle(self) -> Handle
fn into_handle(self) -> Handle
Converts the value into its inner handle.
This is a convenience function which simply forwards to the Into trait.
sourcefn into_raw(self) -> u32
fn into_raw(self) -> u32
Converts the handle into it’s raw representation.
The caller takes ownership over the raw handle, and must close or transfer it to avoid a handle leak.
sourcefn from_handle(handle: Handle) -> Self
fn from_handle(handle: Handle) -> Self
Creates an instance of this type from a handle.
This is a convenience function which simply forwards to the From trait.
sourcefn into_handle_based<H>(self) -> Hwhere
H: HandleBased,
fn into_handle_based<H>(self) -> Hwhere
H: HandleBased,
Creates an instance of another handle-based type from this value’s inner handle.
sourcefn from_handle_based<H>(h: H) -> Selfwhere
H: HandleBased,
fn from_handle_based<H>(h: H) -> Selfwhere
H: HandleBased,
Creates an instance of this type from the inner handle of another handle-based type.