Skip to main content

RelaySender

Struct RelaySender 

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

The single owner of a relay channel.

This type is intentionally not Clone. There is exactly one owner of a channel, and when this owner is dropped, the channel closes.

Use weak() to create WeakSender handles that can send messages without keeping the channel alive.

Implementations§

Source§

impl RelaySender

Source

pub async fn send<T: 'static + Send + Sync>( &self, value: T, ) -> Result<(), SendError>

Send a typed message to all subscribers.

Source

pub async fn send_any( &self, value: Arc<dyn Any + Send + Sync>, type_id: TypeId, ) -> Result<(), SendError>

Send a type-erased message.

Source

pub async fn send_any_with_origin( &self, value: Arc<dyn Any + Send + Sync>, type_id: TypeId, origin: u64, ) -> Result<(), SendError>

Send a type-erased message with a specific origin (for echo prevention).

Source

pub async fn send_envelope(&self, envelope: Envelope) -> Result<(), SendError>

Send a pre-constructed envelope. Used for advanced scenarios like forwarding.

Source

pub fn weak(&self) -> WeakSender

Create a weak sender handle.

Weak senders can send messages but don’t keep the channel alive. Use this for background tasks that should exit when the owner drops.

Source

pub fn is_closed(&self) -> bool

Check if the channel is closed.

Source

pub fn id(&self) -> u64

Get the unique ID of this channel.

Source

pub fn handler_count(&self) -> usize

Get the current handler count for this relay.

Source

pub fn close(&self)

Close the channel explicitly. This has the same effect as dropping the RelaySender.

Trait Implementations§

Source§

impl Drop for RelaySender

Source§

fn drop(&mut self)

Executes the destructor for this type. 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, 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