Struct Channel 

pub struct Channel<D, T, Tr, C: CodecFor<T>> { /* private fields */ }

A typed, directed communication endpoint over a transport half.

Type parameters

• D - direction: Tx or Rx
• T - message type
• Tr - send half (SendTransport) for Tx, receive half (RecvTransport) for Rx
• C - codec; any CodecFor<T> family, e.g. consortium_codec::PostcardCodec

Buffer ownership

Channel does not allocate. The caller provides a &'static mut [u8] scratch buffer at construction. In no_std environments this is typically a static array — see consortium_runtime_mcu::static_buf! for a helper that takes the raw static mut out of application code:

use consortium_codec::PostcardCodec;
use consortium_ipc::{Channel, Tx};

static mut BUF: [u8; 256] = [0u8; 256];

// Taking the one and only reference to BUF.
let buf = unsafe { &mut *core::ptr::addr_of_mut!(BUF) };
let ch = Channel::<Tx, MyMsg, _, PostcardCodec>::new(chan, transport, buf);

The buffer must be at least transport.max_send_size() / max_recv_size() bytes.

Implementations

impl<D, T, Tr, C: CodecFor<T>> Channel<D, T, Tr, C>

pub fn new(chan: Chan, transport: Tr, buf: &'static mut [u8]) -> Self

Construct a Channel.

chan - validated channel identifier transport - initialised transport half buf - scratch buffer, sized for the transport MTU

pub fn chan(&self) -> Chan

The Chan this endpoint is bound to.

impl<T, Tr, C> Channel<Tx, T, Tr, C>

where Tr: SendTransport, C: CodecFor<T>,

pub async fn send(&mut self, msg: &T) -> Result<(), ChannelError<C, Tr>>

Encode msg with the codec and hand the bytes to the transport.

The transport rings the doorbell internally.
Returns when bytes are handed off - not when the remote has processed them.

impl<T, Tr, C> Channel<Rx, T, Tr, C>

where Tr: RecvTransport, C: CodecFor<T>,

pub async fn recv( &mut self, ) -> Result<ReceivedMessage<'_, T, C>, ChannelError<C, Tr>>

Await the next message from the transport and decode it.

Blocks until the transport’s doorbell fires and bytes arrive.
Returns a ReceivedMessage wrapping the decoded value.

When C = PostcardCodec the message is an owned T.
When C is a future zero-copy codec the returned handle will borrow the internal buffer - the '_ lifetime on ReceivedMessage already accommodates this without any change to this signature.