ChannelRegistry

Struct ChannelRegistry 

Source
pub struct ChannelRegistry { /* private fields */ }
Expand description

Registry of active streams for a connection.

Handles incoming streams (Data from wire → Rx<T> / Tx<T> handles). For outgoing streams (server Tx<T> args), spawned tasks drain receivers and send Data/Close messages via driver_tx.

r[impl channeling.unknown] - Unknown stream IDs cause Goodbye.

Implementations§

Source§

impl ChannelRegistry

Source

pub fn new_with_credit_and_role( conn_id: ConnectionId, initial_credit: u32, driver_tx: Sender<DriverMessage>, role: Role, ) -> Self

Create a new registry with the given conn_id, initial credit, driver channel, and role.

The driver_tx is used to send all messages (Call/Data/Close/Response) to the driver for transmission on the wire.

The role determines channel ID parity for response channels:

  • Acceptor (server) uses even IDs
  • Initiator (client) uses odd IDs

r[impl flow.channel.initial-credit] - Each stream starts with this credit.

Source

pub fn new_with_credit( initial_credit: u32, driver_tx: Sender<DriverMessage>, ) -> Self

Create a new registry with the given initial credit and driver channel. Uses ROOT conn_id and Acceptor role for backward compatibility (server-side usage).

r[impl flow.channel.initial-credit] - Each stream starts with this credit.

Source

pub fn new(driver_tx: Sender<DriverMessage>) -> Self

Create a new registry with default infinite credit.

r[impl flow.channel.infinite-credit] - Implementations MAY use very large credit. r[impl flow.channel.zero-credit] - With infinite credit, zero-credit never occurs. This disables backpressure but simplifies implementation.

Source

pub fn conn_id(&self) -> ConnectionId

Get the connection ID for this registry.

Source

pub fn driver_tx(&self) -> Sender<DriverMessage>

Get a clone of the driver message sender.

Used by codegen to spawn tasks that send Data/Close/Response messages.

Source

pub fn response_channel_ids(&self) -> Arc<ChannelIdAllocator>

Get the response channel ID allocator. Used by ForwardingDispatcher to allocate downstream channel IDs for response channels.

Source

pub fn register_incoming(&mut self, channel_id: ChannelId, tx: Sender<Vec<u8>>)

Register an incoming stream.

The connection layer will route Data messages for this channel_id to the sender. Used for both Rx<T> (caller receives from callee) and Tx<T> (callee sends to caller).

r[impl flow.channel.initial-credit] - Stream starts with initial credit.

Source

pub fn register_outgoing_credit(&mut self, channel_id: ChannelId)

Register credit tracking for an outgoing stream.

The actual receiver is NOT stored here - the driver owns it directly. This only sets up credit tracking for the stream.

r[impl flow.channel.initial-credit] - Stream starts with initial credit.

Source

pub fn prepare_route_data( &mut self, channel_id: ChannelId, payload: Vec<u8>, ) -> Result<(Sender<Vec<u8>>, Vec<u8>), ChannelError>

Route a Data message payload to the appropriate incoming stream.

Returns Ok(()) if routed successfully, Err(ChannelError) otherwise.

r[impl channeling.data] - Data messages routed by channel_id. r[impl channeling.data-after-close] - Reject data on closed streams. r[impl flow.channel.credit-overrun] - Reject if data exceeds remaining credit. r[impl flow.channel.credit-consume] - Deduct bytes from remaining credit. r[impl flow.channel.byte-accounting] - Credit measured in payload bytes.

Returns a sender and payload if routing is allowed, or an error. The actual send must be done by the caller to avoid holding locks across await.

Source

pub async fn route_data( &mut self, channel_id: ChannelId, payload: Vec<u8>, ) -> Result<(), ChannelError>

Route a Data message payload to the appropriate incoming stream.

Returns Ok(()) if routed successfully, Err(ChannelError) otherwise.

r[impl channeling.data] - Data messages routed by channel_id. r[impl channeling.data-after-close] - Reject data on closed streams. r[impl flow.channel.credit-overrun] - Reject if data exceeds remaining credit. r[impl flow.channel.credit-consume] - Deduct bytes from remaining credit. r[impl flow.channel.byte-accounting] - Credit measured in payload bytes.

Source

pub fn close(&mut self, channel_id: ChannelId)

Close an incoming stream (remove from registry).

Dropping the sender will cause the Rx<T>’s recv() to return None.

r[impl channeling.close] - Close terminates the stream. r[impl flow.channel.close-exempt] - Close doesn’t consume credit.

Source

pub fn reset(&mut self, channel_id: ChannelId)

Reset a stream (remove from registry, discard credit).

r[impl channeling.reset] - Reset terminates the stream abruptly. r[impl channeling.reset.credit] - Outstanding credit is lost on reset.

Source

pub fn receive_credit(&mut self, channel_id: ChannelId, bytes: u32)

Receive a Credit message - add credit for an outgoing stream.

r[impl flow.channel.credit-grant] - Credit message adds to available credit. r[impl flow.channel.credit-additive] - Credit accumulates additively.

Source

pub fn contains(&self, channel_id: ChannelId) -> bool

Check if a stream ID is registered (either incoming or outgoing credit).

Source

pub fn contains_incoming(&self, channel_id: ChannelId) -> bool

Check if a stream ID is registered as incoming.

Source

pub fn contains_outgoing(&self, channel_id: ChannelId) -> bool

Check if a stream ID has outgoing credit registered.

Source

pub fn is_closed(&self, channel_id: ChannelId) -> bool

Check if a stream has been closed.

Source

pub fn outgoing_count(&self) -> usize

Get the number of active outgoing streams (by credit tracking).

Source

pub fn outgoing_credit(&self, channel_id: ChannelId) -> Option<u32>

Get remaining credit for an outgoing stream.

Returns None if stream is not registered.

Source

pub fn incoming_credit(&self, channel_id: ChannelId) -> Option<u32>

Get remaining credit we’ve granted for an incoming stream.

Returns None if stream is not registered.

Source

pub fn bind_streams<T: Facet<'static>>(&mut self, args: &mut T)

Bind streams in deserialized args for server-side dispatch.

Walks the args using Poke reflection to find any Rx<T> or Tx<T> fields. For each stream found:

  • For Rx<T>: creates a channel, sets the receiver slot, registers for incoming data
  • For Tx<T>: sets the task_tx so send() writes directly to the wire
§Example
let mut args = facet_postcard::from_slice::<(Rx<i32>, Tx<String>)>(&payload)?;
registry.bind_streams(&mut args);
let (input, output) = args;
// ... call handler with input, output ...
// When handler returns and Tx is dropped, Close is sent automatically

Auto Trait Implementations§

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<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

fn if_supports_color<'a, Out, ApplyFn>( &'a self, stream: impl Into<Stream>, apply: ApplyFn, ) -> SupportsColorsDisplay<'a, Self, Out, ApplyFn>
where ApplyFn: Fn(&'a Self) -> Out,

Apply a given transformation function to all formatters if the given stream supports at least basic ANSI colors, allowing you to conditionally apply given styles/colors. Read more
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.