Skip to main content

Payload

Enum Payload 

Source
#[repr(u8)]
pub enum Payload<'payload> { Outgoing { ptr: PtrConst, shape: &'static Shape, _lt: PhantomData<&'payload ()>, }, Incoming(&'payload [u8]), }
Expand description

A payload — arguments for a request, or return type for a response.

Uses #[facet(opaque = PayloadAdapter)] so that format crates handle serialization/deserialization through the adapter contract:

  • Send path: serialize_map extracts (ptr, shape) from Borrowed or Owned.
  • Recv path: deserialize_build produces RawBorrowed or RawOwned.

Variants§

§

Outgoing

Outgoing: type-erased pointer to caller-owned memory + its Shape.

Fields

§shape: &'static Shape
§_lt: PhantomData<&'payload ()>
§

Incoming(&'payload [u8])

Incoming: raw bytes borrowed from the backing (zero-copy).

Implementations§

Source§

impl<'payload> Payload<'payload>

Source

pub fn outgoing<T: Facet<'payload>>(value: &'payload T) -> Self

Construct an outgoing borrowed payload from a concrete value.

Source

pub unsafe fn outgoing_unchecked(ptr: PtrConst, shape: &'static Shape) -> Self

Construct an outgoing owned payload from a raw pointer + shape.

§Safety

The pointed value must remain alive until serialization has completed.

Trait Implementations§

Source§

impl<'payload> Debug for Payload<'payload>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'payload, 'ʄ> Facet<'ʄ> for Payload<'payload>
where 'payload: 'ʄ, 'ʄ: 'payload,

Source§

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else? Read more
Source§

impl<'payload> Send for Payload<'payload>

Auto Trait Implementations§

§

impl<'payload> Freeze for Payload<'payload>

§

impl<'payload> RefUnwindSafe for Payload<'payload>

§

impl<'payload> !Sync for Payload<'payload>

§

impl<'payload> Unpin for Payload<'payload>

§

impl<'payload> UnsafeUnpin for Payload<'payload>

§

impl<'payload> UnwindSafe for Payload<'payload>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> MaybeSend for T
where T: Send,