Skip to main content

Box

fidl_next_codec::wire

Struct Box

pub struct Box<'de, T> { /* private fields */ }

Expand description

A boxed (optional) FIDL value.

Implementations§

impl<T> Box<'_, T>

pub fn encode_present(out: &mut MaybeUninit<Self>)

Encodes that a value is present in an output.

pub fn encode_absent(out: &mut MaybeUninit<Self>)

Encodes that a value is absent in a slot.

pub fn is_some(&self) -> bool

Returns whether the value is present.

pub fn is_none(&self) -> bool

Returns whether the value is absent.

pub fn as_ref(&self) -> Option<&T>

Returns a reference to the boxed value, if any.

pub fn into_option(self) -> Option<T>

Returns an Owned of the boxed value, if any.

Trait Implementations§

impl<T: Constrained> Constrained for Box<'_, T>

type Constraint = <T as Constrained>::Constraint

Type of constraint information for this type.

fn validate( slot: Slot<'_, Self>, constraint: Self::Constraint, ) -> Result<(), ValidationError>

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

impl<T: Debug> Debug for Box<'_, T>

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

Formats the value using the given formatter. Read more

impl<'de, D: Decoder<'de> + ?Sized, T: Decode<D>> Decode<D> for Box<'de, T>

fn decode( slot: Slot<'_, Self>, decoder: &mut D, constraint: Self::Constraint, ) -> Result<(), DecodeError>

Decodes a value into a slot using a decoder. Read more

impl<T> Drop for Box<'_, T>

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<E> EncodeOption<Box<'static, ()>, E> for &()
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, ()>>, constraint: <() as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, ()>, E> for ()
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, ()>>, constraint: <() as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Float32>, E> for &Float32
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Float32>>, constraint: <Float32 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Float32>, E> for &f32
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Float32>>, constraint: <Float32 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Float32>, E> for Float32
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Float32>>, constraint: <Float32 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Float32>, E> for f32
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Float32>>, constraint: <Float32 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Float64>, E> for &Float64
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Float64>>, constraint: <Float64 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Float64>, E> for &f64
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Float64>>, constraint: <Float64 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Float64>, E> for Float64
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Float64>>, constraint: <Float64 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Float64>, E> for f64
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Float64>>, constraint: <Float64 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Int16>, E> for &Int16
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Int16>>, constraint: <Int16 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Int16>, E> for &i16
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Int16>>, constraint: <Int16 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Int16>, E> for Int16
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Int16>>, constraint: <Int16 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Int16>, E> for i16
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Int16>>, constraint: <Int16 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Int32>, E> for &Int32
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Int32>>, constraint: <Int32 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Int32>, E> for &i32
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Int32>>, constraint: <Int32 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Int32>, E> for Int32
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Int32>>, constraint: <Int32 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Int32>, E> for i32
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Int32>>, constraint: <Int32 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Int64>, E> for &Int64
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Int64>>, constraint: <Int64 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Int64>, E> for &i64
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Int64>>, constraint: <Int64 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Int64>, E> for Int64
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Int64>>, constraint: <Int64 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Int64>, E> for i64
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Int64>>, constraint: <Int64 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Uint16>, E> for &Uint16
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Uint16>>, constraint: <Uint16 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Uint16>, E> for &u16
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Uint16>>, constraint: <Uint16 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Uint16>, E> for Uint16
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Uint16>>, constraint: <Uint16 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Uint16>, E> for u16
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Uint16>>, constraint: <Uint16 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Uint32>, E> for &Uint32
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Uint32>>, constraint: <Uint32 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Uint32>, E> for &u32
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Uint32>>, constraint: <Uint32 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Uint32>, E> for Uint32
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Uint32>>, constraint: <Uint32 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Uint32>, E> for u32
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Uint32>>, constraint: <Uint32 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Uint64>, E> for &Uint64
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Uint64>>, constraint: <Uint64 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Uint64>, E> for &u64
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Uint64>>, constraint: <Uint64 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Uint64>, E> for Uint64
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Uint64>>, constraint: <Uint64 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, Uint64>, E> for u64
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, Uint64>>, constraint: <Uint64 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, bool>, E> for &bool
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, bool>>, constraint: <bool as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, bool>, E> for bool
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, bool>>, constraint: <bool as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, i8>, E> for &i8
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, i8>>, constraint: <i8 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, i8>, E> for i8
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, i8>>, constraint: <i8 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, u8>, E> for &u8
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, u8>>, constraint: <u8 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E> EncodeOption<Box<'static, u8>, E> for u8
where E: Encoder + ?Sized,

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<Box<'static, u8>>, constraint: <u8 as Constrained>::Constraint, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<T: FromWire<W>, W> FromWireOption<Box<'_, W>> for T

fn from_wire_option(wire: Box<'_, W>) -> Option<Self>

Converts the given owned value to an option of this type.

impl<T: FromWireRef<W>, W> FromWireOptionRef<Box<'_, W>> for T

fn from_wire_option_ref(wire: &Box<'_, W>) -> Option<Self>

Converts the given reference to an option of this type.

impl<T: IntoNatural> IntoNatural for Box<'_, T>

type Natural = Option<<T as IntoNatural>::Natural>

A good default type for this wire type to convert into.

fn into_natural(self) -> Self::Natural

Converts this type into its natural equivalent.

impl<T: Wire> Wire for Box<'static, T>

type Narrowed<'de> = Box<'de, <T as Wire>::Narrowed<'de>>

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

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

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

impl<T: Send> Send for Box<'_, T>

impl<T: Sync> Sync for Box<'_, T>

Auto Trait Implementations§

impl<'de, T> Freeze for Box<'de, T>

impl<'de, T> RefUnwindSafe for Box<'de, T>
where T: RefUnwindSafe,

impl<'de, T> Unpin for Box<'de, T>

impl<'de, T> !UnwindSafe for Box<'de, T>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.