Struct Handle 

pub struct Handle { /* private fields */ }

A handle of unspecified type within a remote FDomain.

Implementations

impl Handle

pub fn id(&self) -> u32

Returns the ID of the Handle. This should be unique to the handle for its lifetime.

pub fn has_client(&self) -> bool

Checks if there is an active client for this handle.

Only really useful if you are doing something when this function returning false, and you want to fail fast with a specific error.

pub fn invalid() -> Self

Get an invalid handle.

pub fn as_unowned<H: HandleBased>(&self) -> Unowned<H>

Convert this into an unowned handle (one that is borrowed and will not close when dropped).

An example:

let handle: &Handle = /* ... */;
let socket = handle.as_unowned::<fdomain_client::Socket>();
let mut buf: [u8; 4096] = [0; 4096];
socket.read(&mut buf[..]).await?;

This is only really useful for contexts in which the handles are going to be stored and retrieved from a data structure and potentially used as arbitrary handle-based data types.

impl Handle

pub fn close(self) -> impl Future<Output = Result<(), Error>>

Close this handle. Surfaces errors that dropping the handle will not.

pub fn replace( self, rights: Rights, ) -> impl Future<Output = Result<Handle, Error>>

Replace this handle with a new handle to the same object, with different rights.

Trait Implementations

impl AsHandleRef for Handle

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

Get a HandleRef referring to the handle contained in Self

fn object_type() -> ObjectType

Get the object type of this handle.

fn u32_id(&self) -> u32

fn signal_handle( &self, set: Signals, clear: Signals, ) -> impl Future<Output = Result<(), Error>>

fn domain(&self) -> Arc<Client>

Get the client supporting this handle. See fidl::Proxy::domain.

impl Debug for Handle

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

Formats the value using the given formatter.

impl Drop for Handle

fn drop(&mut self)

Executes the destructor for this type.

impl EncodableAsHandle for Handle

type Dialect = FDomainResourceDialect

What resource dialect can encode this object as a handle.

impl<E: HandleEncoder + ?Sized> Encode<WireHandle, E> for Handle

fn encode( self, encoder: &mut E, out: &mut MaybeUninit<WireHandle>, _: (), ) -> 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: HandleEncoder + ?Sized> EncodeOption<WireOptionalHandle, E> for Handle

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<WireOptionalHandle>, _: (), ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl From<AnyHandle> for Handle

fn from(item: AnyHandle) -> Handle

Converts to this type from the input type.

impl From<Channel> for Handle

fn from(other: Channel) -> Handle

Converts to this type from the input type.

impl<T: ProtocolMarker> From<ClientEnd<T>> for Handle

fn from(client: ClientEnd<T>) -> Handle

Converts to this type from the input type.

impl From<Event> for Handle

fn from(other: Event) -> Handle

Converts to this type from the input type.

impl From<Eventpair> for Handle

fn from(other: Eventpair) -> Handle

Converts to this type from the input type.

impl From<Handle> for Channel

fn from(other: Handle) -> Channel

Converts to this type from the input type.

impl<T: ProtocolMarker> From<Handle> for ClientEnd<T>

fn from(handle: Handle) -> Self

Converts to this type from the input type.

impl From<Handle> for Event

fn from(other: Handle) -> Event

Converts to this type from the input type.

impl From<Handle> for Eventpair

fn from(other: Handle) -> Eventpair

Converts to this type from the input type.

impl<T: ProtocolMarker> From<Handle> for ServerEnd<T>

fn from(handle: Handle) -> Self

Converts to this type from the input type.

impl From<Handle> for Socket

fn from(other: Handle) -> Socket

Converts to this type from the input type.

impl From<Handle> for WireHandle

fn from(handle: Handle) -> WireHandle

Converts to this type from the input type.

impl<T: ProtocolMarker> From<ServerEnd<T>> for Handle

fn from(server: ServerEnd<T>) -> Handle

Converts to this type from the input type.

impl From<Socket> for Handle

fn from(other: Socket) -> Handle

Converts to this type from the input type.

impl FromWire<WireHandle> for Handle

fn from_wire(wire: WireHandle) -> Self

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<WireOptionalHandle> for Handle

fn from_wire_option(wire: WireOptionalHandle) -> Option<Self>

Converts the given wire to an option of this type.

impl HandleBased for Handle

fn invalidate(&mut self)

Drop ownership of this handle and make it invalid, without closing the handle.

fn close(self) -> impl Future<Output = Result<(), Error>>

Closes this handle. Surfaces errors that dropping the handle will not.

fn duplicate_handle( &self, rights: Rights, ) -> impl Future<Output = Result<Self, Error>>

Duplicate this handle.

fn replace_handle( self, rights: Rights, ) -> impl Future<Output = Result<Self, Error>>

Replace this handle with an equivalent one with different rights.

fn into_handle(self) -> Handle

Convert this handle-based value into a pure Handle.

fn from_handle(handle: Handle) -> Self

Construct a new handle-based value from a Handle.

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

Turn this handle-based value into one of a different type.

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

Turn another handle-based type into this one.

impl HandleFor<FDomainResourceDialect> for Handle

type HandleInfo = HandleInfo

Handle info used in this dialect.

fn invalid() -> Self

Produce an invalid version of Handle used as a place filler when we remove handles from an array.

fn is_invalid(&self) -> bool

Check whether a handle is invalid.

impl Hash for Handle

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

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 Handle

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

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

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