Module fidl::encoding

FIDL encoding and decoding.

Macros

• const_assert_eq
  Asserts that constants are equal in value.

Structs

• Ambiguous1
  A fake FIDL type that can encode from and decode into any Rust type.
• Ambiguous2
  Like Ambiguous1. There needs to be two of these types so that the compiler doesn’t infer one of them and generate a call to the panicking methods.
• Array
  The FIDL type array<T, N>.
• AtRestFlags
  Bitflags type for transaction header at-rest flags.
• BoundedString
  The FIDL type string:N.
• Boxed
  The FIDL type box<T>.
• Context
  Context for encoding and decoding.
• Decoder
  Decoding state
• DefaultFuchsiaResourceDialect
  The default ResourceDialect. Encodes everything into a channel MessageBuf for sending via channels between Fuchsia services.
• DynamicFlags
  Bitflags type to flags that aid in dynamically identifying features of the request.
• EmptyPayload
  A FIDL type representing an empty payload (0 bytes).
• EmptyStruct
  The FIDL type used for an empty success variant in a result union. Result unions occur in two-way methods that are flexible or that use error syntax.
• Encoder
  Encoding state
• EpitaphBody
  The body of a FIDL Epitaph
• FlexibleResultType
  The FIDL union generated for flexible two-way methods with errors.
• FlexibleType
  The FIDL union generated for flexible two-way methods without errors.
• FuchsiaProxyBox
  Box around an async channel. Needed to implement ResourceDialect for DefaultFuchsiaResourceDialect but not so useful for that case.
• GenericMessage
  A struct which encodes as GenericMessageType<H, T> where E: Encode<T>.
• GenericMessageType
  The FIDL type for a message consisting of a header H and body T.
• HandleType
  The FIDL type zx.Handle:<OBJECT_TYPE, RIGHTS>, or a client_end or server_end.
• Optional
  The FIDL type T:optional where T is a vector, string, handle, or client/server end.
• OptionalUnion
  The FIDL type T:optional where T is a union.
• ResultType
  The FIDL union generated for strict two-way methods with errors.
• TlsBuf
  Thread-local buffer for encoding and decoding FIDL transactions. Needed to implement ResourceDialect.
• TransactionHeader
  Header for transactional FIDL messages
• Vector
  The FIDL type vector<T>:N.

Enums

• AmbiguousNever
  An uninhabited type used as owned and borrowed type for ambiguous markers. Can be replaced by ! once that is stable.
• FrameworkErr
  Internal FIDL framework error type used to identify unknown methods.
• GenericMessageOwned
  The owned type for GenericMessageType.
• WireFormatVersion
  Wire format version to use during encode / decode.

Constants

• ALLOC_ABSENT_U32
  Indicates that an optional value is absent.
• ALLOC_ABSENT_U64
  Indicates that an optional value is absent.
• ALLOC_PRESENT_U32
  Indicates that an optional value is present.
• ALLOC_PRESENT_U64
  Indicates that an optional value is present.
• EPITAPH_ORDINAL
  Special ordinal signifying an epitaph message.
• MAGIC_NUMBER_INITIAL
  The current wire format magic number
• MAX_BOUND
  The maximum vector bound, corresponding to the MAX constraint in FIDL.
• MAX_HANDLES
  The maximum number of handles allowed in a FIDL message.
• MAX_RECURSION
  The maximum recursion depth of encoding and decoding. Each pointer to an out-of-line object counts as one step in the recursion depth.

Traits

• Decode
  A Rust type that can be decoded from the FIDL type T.
• EncodableAsHandle
  Indicates a type is encodable as a handle in a given resource dialect.
• Encode
  A Rust type that can be encoded as the FIDL type T.
• HandleDispositionFor
  Handle disposition struct used for a particular dialect.
• HandleFor
  Handle type used for a particular dialect.
• HandleInfoFor
  Handle info struct used for a particular dialect.
• MessageBufFor
  Message buffer used to hold a message in a particular dialect.
• ProxyChannelBox
  Trait for a “Box” that wraps a handle when it’s inside a client. Useful when we need some infrastructure to make our underlying channels work the way the client code expects.
• ProxyChannelFor
  Channel used for proxies in a particular dialect.
• ResourceDialect
  Describes how a given transport encodes resources like handles.
• ResourceTypeMarker
  A FIDL resource type marker.
• TypeMarker
  A FIDL type marker.
• ValueTypeMarker
  A FIDL value type marker.

Functions

• decode_transaction_header
  Decodes the transaction header from a message. Returns the header and a reference to the tail of the message.
• with_tls_decode_buf
  Acquire a mutable reference to the thread-local buffers used for decoding.
• with_tls_encode_buf
  Acquire a mutable reference to the thread-local buffers used for encoding.
• with_tls_encoded
  Encodes the provided type into the thread-local encoding buffers.

Type Aliases

• Endpoint
  An abbreviation of HandleType that for channels with default rights, used for the FIDL types client_end:P and server_end:P.
• NoHandleResourceDialect
  A resource dialect which doesn’t support handles at all.
• TransactionMessage
  A struct which encodes as TransactionMessageType<T> where E: Encode<T>.
• TransactionMessageType
  The FIDL type for a transaction message with body T.
• UnboundedString
  The FIDL type string or string:MAX.
• UnboundedVector
  The FIDL type vector<T> or vector<T>:MAX.