Struct Rx 

pub struct Rx<T: 'static> {
    pub channel_id: ChannelId,
    pub receiver: ReceiverSlot,
    /* private fields */
}

Rx stream handle - caller receives data from callee.

r[impl channeling.caller-pov] - From caller’s perspective, Rx means “I receive”. r[impl channeling.type] - Serializes as u64 stream ID on wire. r[impl channeling.holder-semantics] - The holder receives from this stream.

Facet Implementation

Uses #[facet(proxy = u64)] so that:

• channel_id is pokeable (Connection can walk args and set stream IDs)
• Serializes as just a u64 on the wire
• T is exposed as a type parameter for codegen introspection

The receiver field uses ReceiverSlot wrapper so that ConnectionHandle::call can use Poke::get_mut::<ReceiverSlot>() to .take() the receiver and register it with the stream registry.

Fields

channel_id: ChannelId

The unique stream ID for this stream. Public so Connection can poke it when binding streams.

receiver: ReceiverSlot

Channel receiver for incoming data. Uses ReceiverSlot so it’s pokeable (can .take() via Poke).

Implementations

impl<T: 'static> Rx<T>

pub fn new(channel_id: ChannelId, rx: Receiver<Vec<u8>>) -> Self

Create a new Rx stream with the given ID and receiver channel.

pub fn unbound(rx: Receiver<Vec<u8>>) -> Self

Create an unbound Rx with a receiver but channel_id 0.

Used by roam::channel() to create a pair before binding. Connection will poke the channel_id when binding.

pub fn bound(channel_id: ChannelId, rx: Receiver<Vec<u8>>) -> Self

Create a bound Rx with channel_id already set.

Used by roam::channel() when called during dispatch to create response channels. The channel_id will be serialized and sent to the client, who will bind a receiver for incoming Data.

pub fn channel_id(&self) -> ChannelId

Get the stream ID.

pub async fn recv(&mut self) -> Result<Option<T>, RxError>

where T: Facet<'static>,

Receive the next value from this stream.

Returns Ok(Some(value)) for each received value, Ok(None) when the stream is closed, or Err if deserialization fails.

r[impl channeling.data] - Deserialize Data message payloads. r[impl channeling.data.invalid] - Caller must send Goodbye on deserialize error.

Trait Implementations

impl<'ʄ, T> Facet<'ʄ> for Rx<T>

where T: Facet<'ʄ> + 'static,

const SHAPE: &'static Shape

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

impl<T: 'static> TryFrom<&Rx<T>> for u64

Serialization: &Rx<T> -> u64 (extracts channel_id)

Uses TryFrom rather than From because facet’s proxy mechanism requires TryFrom.

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(rx: &Rx<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: 'static> TryFrom<u64> for Rx<T>

Deserialization: u64 -> Rx<T> (creates a “hollow” Rx)

The receiver is a placeholder - the real receiver gets set up by Connection after deserialization when it binds the stream.

Uses TryFrom rather than From because facet’s proxy mechanism requires TryFrom.

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(channel_id: u64) -> Result<Self, Self::Error>

Performs the conversion.