Tx

Struct Tx 

Source
pub struct Tx<T: 'static> {
    pub conn_id: ConnectionId,
    pub channel_id: ChannelId,
    pub sender: SenderSlot,
    pub driver_tx: DriverTxSlot,
    /* private fields */
}
Expand description

Tx stream handle - caller sends data to callee.

r[impl channeling.caller-pov] - From caller’s perspective, Tx means “I send”. r[impl channeling.type] - Serializes as u64 stream ID on wire. r[impl channeling.holder-semantics] - The holder sends on this stream. r[impl channeling.channels-outlive-response] - Tx streams may outlive Response. r[impl channeling.lifecycle.immediate-data] - Can send Data before Response. r[impl channeling.lifecycle.speculative] - Early Data may be wasted on error.

§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

§Two modes of operation

  • Client side: sender holds a channel to an intermediate drain task. ConnectionHandle::call takes the receiver and drains it to wire.
  • Server side: task_tx holds a direct channel to the connection driver. ChannelRegistry::bind_streams sets this, and send() writes DriverMessage::Data.

Fields§

§conn_id: ConnectionId

The connection ID this stream belongs to.

§channel_id: ChannelId

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

§sender: SenderSlot

Channel sender for outgoing data (client-side mode). Used when Tx is created via roam::channel().

§driver_tx: DriverTxSlot

Direct driver message sender (server-side mode). Used when Tx is hydrated by ChannelRegistry::bind_streams.

Implementations§

Source§

impl<T: 'static> Tx<T>

Source

pub fn new(channel_id: ChannelId, tx: Sender<Vec<u8>>) -> Self

Create a new Tx stream with the given ID and sender channel (client-side mode).

Source

pub fn unbound(tx: Sender<Vec<u8>>) -> Self

Create an unbound Tx with a sender but channel_id 0.

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

Source

pub fn bound( conn_id: ConnectionId, channel_id: ChannelId, tx: Sender<Vec<u8>>, driver_tx: Sender<DriverMessage>, ) -> Self

Create a bound Tx with conn_id, channel_id and driver_tx already set.

Used by roam::channel() when called during dispatch to create response channels that can send Data directly over the wire.

Source

pub fn channel_id(&self) -> ChannelId

Get the stream ID.

Source

pub async fn send(&self, value: &T) -> Result<(), TxError>
where T: Facet<'static>,

Send a value on this stream.

r[impl channeling.data] - Data messages carry serialized values.

Works in two modes:

  • Client-side (or passthrough): sends raw bytes to intermediate channel (drained by connection)
  • Server-side: sends DriverMessage::Data directly to connection driver

IMPORTANT: We prefer sender over driver_tx because when a channel created during dispatch is passed to a callback, the rx gets a NEW channel_id allocated by the caller’s bind_streams. The drain task uses that new channel_id, while self.channel_id still has the old dispatch-context channel_id. By using sender, data flows through the drain task which uses the correct channel_id.

Trait Implementations§

Source§

impl<T: 'static> Drop for Tx<T>

When a Tx is dropped, send a Close message.

r[impl channeling.close] - Close terminates the stream.

The Close path depends on how data was sent:

  • If sender is present: data went through drain task, drain task sends Close when channel closes
  • If only driver_tx is present: data went directly to driver, we send Close via driver_tx
Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<'ʄ, T> Facet<'ʄ> for Tx<T>
where T: Facet<'ʄ> + 'static,

Source§

const SHAPE: &'static Shape

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

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

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

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

Source§

type Error = Infallible

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

fn try_from(tx: &Tx<T>) -> Result<Self, Self::Error>

Performs the conversion.
Source§

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

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

Both sender slots are empty - the real sender gets set up by Connection after deserialization when it binds the stream.

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

Source§

type Error = Infallible

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

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

Performs the conversion.

Auto Trait Implementations§

§

impl<T> Freeze for Tx<T>

§

impl<T> RefUnwindSafe for Tx<T>
where T: RefUnwindSafe,

§

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

§

impl<T> Sync for Tx<T>
where T: Sync,

§

impl<T> Unpin for Tx<T>
where T: Unpin,

§

impl<T> UnwindSafe for Tx<T>
where T: UnwindSafe,

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<'a, T> FacetPretty<'a> for T
where T: Facet<'a>,

Source§

fn pretty(&self) -> PrettyDisplay<'a, '_, T>

Get a displayable wrapper that pretty-prints this value
Source§

fn pretty_with(&self, printer: PrettyPrinter) -> PrettyDisplay<'a, '_, T>

Get a displayable wrapper with custom printer settings
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.