Crate flex_client

Source

Modules§

client
An implementation of a client for a fidl interface.
encoding
FIDL encoding and decoding.
endpoints
Wrapper types for the endpoints of a connection.
epitaph
Epitaph support for Channel and AsyncChannel.
fidl
for_fidl_message_crate
This belongs in the //src/lib/fidl/rust/fidl_message crate, but has to go here to work around the “upstream crates may add a new impl of trait” error https://doc.rust-lang.org/error_codes/E0119.html.
handle
A portable representation of handle-like objects for fidl.
marker
Marker types supporting FIDL bindings.
prelude
A “prelude” of common FIDL traits, to be used like use fidl::prelude::*;.
server
An implementation of a server for a fidl interface.

Macros§

invoke_for_handle_types
invoke_for_handle_types!{mmm} calls the macro mmm! with two arguments: one is the name of a Zircon handle, the second is one of:

Structs§

AsyncChannel
An I/O object representing a Channel.
AsyncSocket
An I/O object representing a Socket.
Bti
Stub implementation of Zircon handle type $x.
Channel
An object representing a Zircon channel.
Clock
An object representing a kernel clock, used to track the progress of time. A clock is a one-dimensional affine transformation of the clock monotonic reference timeline which may be atomically adjusted by a maintainer and observed by clients.
Counter
An object representing a Zircon counter.
DebugLog
An object representing a Zircon ‘debuglog’ object.
Event
An object representing a Zircon event object.
EventPair
An object representing a Zircon event_pair
Exception
Stub implementation of Zircon handle type $x.
Fifo
An object representing a Zircon fifo.
Guest
An object representing a Zircon guest
Handle
An object representing a Zircon handle.
HandleDisposition
Operation to perform on handles during write. ABI-compatible with zx_handle_disposition_t.
HandleInfo
Information on handles that were read.
Instant
A timestamp from the kernel. Generic over both the timeline and the units it is measured in.
Interrupt
An object representing a Zircon interrupt.
Iob
An object representing a Zircon IOBuffer.
Iommu
Stub implementation of Zircon handle type $x.
Job
An object representing a Zircon job.
MessageBuf
A buffer for receiving messages from a channel.
MessageBufEtc
A buffer for receiving messages from a channel.
Msi
Stub implementation of Zircon handle type $x.
NsUnit
A marker type representing nanoseconds.
ObjectType
Zircon object types.
Pager
Stub implementation of Zircon handle type $x.
PciDevice
Stub implementation of Zircon handle type $x.
Pmt
Stub implementation of Zircon handle type $x.
Port
An object representing a Zircon port.
Process
An object representing a Zircon process.
Profile
An object representing a Zircon profile.
Resource
An object representing a Zircon resource.
Rights
Rights associated with a handle.
ServeInner
A type used from the innards of server implementations.
Signals
Signals that can be waited upon.
Socket
An object representing a Zircon socket
SocketOpts
Status
Status type indicating the result of a Fuchsia syscall.
Stream
An object representing a Zircon stream.
SuspendToken
Stub implementation of Zircon handle type $x.
Thread
An object representing a Zircon thread.
TicksUnit
A marker type representing system ticks.
Timer
An object representing a Zircon timer, such as the one returned by zx_timer_create.
Vcpu
Vmar
An object representing a Zircon virtual memory address region.
Vmo
An object representing a Zircon virtual memory object.
WireMetadata
Header for RFC-0120 persistent FIDL messages.

Enums§

Error
The error type used by FIDL operations.
HandleOp
Handle operation.
MethodType
The type of a client-initiated method.
TransportError

Traits§

AsHandleRef
A trait to get a reference to the underlying handle of an object.
HandleBased
A trait implemented by all handle-based types.
Peered
A trait implemented by all handles for objects which have a peer.
Persistable
Marker trait implemented for FIDL non-resource structs, tables, and unions. These can be used with the persistence API and standalone encoding/decoding API.
ProxyHasDomain
This gives native Zircon proxies a domain method like FDomain proxies have. This makes it easier in some cases to build the same code for both FDomain and regular FIDL.
Standalone
Marker trait implemented for FIDL resource structs, tables, and unions. These can be used with the standalone encoding/decoding API, but not the persistence API.
Timeline
A marker trait for times to prevent accidental comparison between different timelines.

Functions§

convert_handle_dispositions_to_infos
Converts a vector of HandleDisposition (handles bundled with their intended object type and rights) to a vector of HandleInfo (handles bundled with their actual type and rights, guaranteed by the kernel).
persist
Encodes a FIDL object to bytes following RFC-0120. This only works on non-resource structs, tables, and unions. See unpersist for the reverse.
standalone_decode_resource
Decodes a FIDL object from bytes, handles, and wire metadata following RFC-0120. Must be a resource struct, table, or union.
standalone_decode_value
Decodes a FIDL object from bytes and wire metadata following RFC-0120. Must be a non-resource struct, table, or union.
standalone_encode_resource
Encodes a FIDL object to bytes, handles, and wire metadata following RFC-0120. Must be a resource struct, table, or union.
standalone_encode_value
Encodes a FIDL object to bytes and wire metadata following RFC-0120. Must be a non-resource struct, table, or union.
unpersist
Decodes a FIDL object from bytes following RFC-0120. Must be a non-resource struct, table, or union. See persist for the reverse.

Type Aliases§

BootInstant
A timestamp from the boot clock. Advances while the system is suspended.
BootTicks
A timestamp from system ticks on the boot timeline. Advances while the system is suspended.
Dialect
HandleRef
MonotonicInstant
A timestamp from the monontonic clock. Does not advance while the system is suspended.
MonotonicTicks
A timestamp from system ticks on the monotonic timeline. Does not advance while the system is suspended.
OnSignalsRef
Alias for the common case where OnSignals is used with zx::HandleRef.
Result
A specialized Result type for FIDL operations.
Ticks
A timestamp from system ticks. Has an arbitrary unit that can be measured with Ticks::per_second().