Channel

Struct Channel 

Source
pub struct Channel {
    pub rx: UnboundedReceiver<Result<Message, Error>>,
    pub tx: UnboundedSender<Result<Message, Error>>,
}
Expand description

A channel endpoint representing one side of a bidirectional message channel.

Channel represents a single endpoint’s view of a bidirectional communication channel. Each endpoint has:

  • rx: A receiver for incoming messages (or errors) from the counterpart
  • tx: A sender for outgoing messages (or errors) to the counterpart

§Example

// Create a pair of connected channels
let (channel_a, channel_b) = Channel::duplex();

// Each channel can be used by a different component
UntypedLink::builder()
    .name("connection-a")
    .serve(channel_a)
    .await?;

Fields§

§rx: UnboundedReceiver<Result<Message, Error>>

Receives messages (or errors) from the counterpart.

§tx: UnboundedSender<Result<Message, Error>>

Sends messages (or errors) to the counterpart.

Implementations§

Source§

impl Channel

Source

pub fn duplex() -> (Self, Self)

Create a pair of connected channel endpoints.

Returns two Channel instances that are connected to each other:

  • Messages sent via channel_a.tx are received on channel_b.rx
  • Messages sent via channel_b.tx are received on channel_a.rx
§Returns

A tuple (channel_a, channel_b) of connected channel endpoints.

Source

pub async fn copy(self) -> Result<(), Error>

Copy messages from rx to tx.

§Returns

A Result indicating success or failure.

Trait Implementations§

Source§

impl<L: JrLink> Component<L> for Channel

Source§

async fn serve(self, client: impl Component<L::ConnectsTo>) -> Result<(), Error>

Serve this component by forwarding to a client component. Read more
Source§

fn into_server(self) -> (Channel, BoxFuture<'static, Result<(), Error>>)

Convert this component into a channel endpoint and server future. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoMaybeUndefined<T> for T

Source§

impl<T> IntoOption<T> for T

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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more