Union Envelope 

pub union Envelope {
    /* private fields */
}

A FIDL envelope

Implementations

impl Envelope

pub fn encode_zero(out: &mut MaybeUninit<Envelope>)

Encodes a zero envelope into a slot.

pub fn encode_value_static<W, E>( value: impl Encode<W, E>, encoder: &mut E, out: &mut MaybeUninit<Envelope>, constraint: <W as Constrained>::Constraint, ) -> Result<(), EncodeError>

where W: Wire, E: InternalHandleEncoder + ?Sized,

Encodes a 'static value into an envelope with an encoder.

pub fn encode_value<W, E>( value: impl Encode<W, E>, encoder: &mut E, out: &mut MaybeUninit<Envelope>, constraint: <W as Constrained>::Constraint, ) -> Result<(), EncodeError>

where W: Wire, E: Encoder + ?Sized,

Encodes a value into an envelope with an encoder.

pub fn zero() -> Envelope

Returns the zero envelope.

pub fn is_encoded_zero(slot: Slot<'_, Envelope>) -> bool

Returns whether a envelope slot is encoded as zero.

pub fn is_zero(&self) -> bool

Returns whether an envelope is zero.

pub fn decode_unknown_static<D>( slot: Slot<'_, Envelope>, decoder: &mut D, ) -> Result<(), DecodeError>

where D: InternalHandleDecoder + ?Sized,

Decodes and discards a static type in an envelope.

pub fn decode_unknown<'de, D>( slot: Slot<'_, Envelope>, decoder: &mut D, ) -> Result<(), DecodeError>

where D: Decoder<'de> + ?Sized,

Decodes and discards an unknown value in an envelope.

pub fn decode_as_static<D, T>( slot: Slot<'_, Envelope>, decoder: &mut D, constraint: <T as Constrained>::Constraint, ) -> Result<(), DecodeError>

where D: InternalHandleDecoder + ?Sized, T: Decode<D>,

Decodes a value of a known type from an envelope.

pub fn decode_as<'de, D, T>( slot: Slot<'_, Envelope>, decoder: &mut D, constraint: <T as Constrained>::Constraint, ) -> Result<(), DecodeError>

where D: Decoder<'de> + ?Sized, T: Decode<D>,

Decodes a value of a known type from an envelope.

pub unsafe fn as_ptr<T>(this: *mut Envelope) -> *mut T

Returns a pointer to the value contained in the envelope.

Safety

this must point to a valid envelope that was successfully decoded.

pub unsafe fn deref_unchecked<T>(&self) -> &T

Returns a reference to the contained T.

Safety

The envelope must have been successfully decoded as a T.

pub unsafe fn read_unchecked<T>(&self) -> T

Returns the contained T.

Safety

The envelope must have been successfully decoded as a T. Reading from an envelope can cause undefined behavior if the underlying value is dropped later. Precautions should be taken to ensure that values read from an envelope are not dropped twice.

pub unsafe fn take_unchecked<T>(&mut self) -> T

Takes the contained T out of the envelope.

Safety

The envelope must have been successfully decoded as a T.

pub unsafe fn clone_inline_unchecked<T>(&self) -> Envelope

where T: Clone,

Clones the envelope, assuming that it contains an inline T.

Safety

The envelope must have been successfully decoded inline as a T.

Trait Implementations

impl Constrained for Envelope

type Constraint = ()

Type of constraint information for this type.

fn validate( _: Slot<'_, Envelope>, _: <Envelope as Constrained>::Constraint, ) -> Result<(), ValidationError>

Validate a slot of this type against a constraint. Can be called when pointers/envelopes are just presence markers.

impl Wire for Envelope

type Narrowed<'de> = Envelope

The narrowed wire type, restricted to the 'de lifetime.

fn zero_padding(_: &mut MaybeUninit<Envelope>)

Writes zeroes to the padding for this type, if any.

impl Send for Envelope

impl Sync for Envelope