Skip to main content

RelayReceiver

Struct RelayReceiver 

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

A receiver handle for subscribing to channel messages.

This type is Clone but does not keep the channel alive. When the RelaySender is dropped, all subscriptions will return None.

Implementations§

Source§

impl RelayReceiver

Source

pub fn subscribe<T: 'static + Send + Sync>(&self) -> Subscription<T>

Subscribe to messages of type T.

Returns a Subscription that yields messages until the channel closes.

Source

pub fn subscribe_all(&self) -> Receiver<Envelope>

Subscribe to all messages regardless of type.

Returns raw Envelopes containing type-erased values.

Source

pub fn subscribe_tracked<T: 'static + Send + Sync>( &self, ) -> (Subscription<T>, Arc<AtomicUsize>)

Subscribe with completion tracking (for internal use). Returns (subscription, handler_count). The subscription is immediately ready to receive messages (channel is created and buffering).

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 sink<T, F, R>(&self, f: F)
where T: 'static + Send + Sync, F: Fn(&T) -> R + Send + Sync + 'static, R: IntoResult + 'static,

Attach a handler that consumes messages of type T.

The sender will wait for this handler to complete before send() returns. Errors and panics are propagated back to the sender via the completion tracker.

Source

pub fn tap<T, F, R>(&self, f: F)
where T: 'static + Send + Sync, F: Fn(&T) -> R + Send + Sync + 'static, R: IntoResult + 'static,

Attach an observer that sees messages of type T without consuming them.

Similar to sink() but doesn’t prevent other handlers from receiving the message. The sender will wait for this handler to complete before send() returns.

Source

pub fn within<F, Fut>(&self, f: F)
where F: FnOnce() -> Fut + Send + 'static, Fut: Future<Output = ()> + Send,

Spawn a custom async task with panic catching.

Unlike sink/tap, this does NOT participate in completion tracking. Panics are caught but not propagated (just logged).

Trait Implementations§

Source§

impl Clone for RelayReceiver

Source§

fn clone(&self) -> RelayReceiver

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
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