Skip to main content

SignalStream

Struct SignalStream 

Source
pub struct SignalStream<T>
where T: Clone,
{ /* private fields */ }
Expand description

A stream of signal value changes.

SignalStream wraps a broadcast receiver and provides filtering capabilities. It implements async iteration for use in event loops.

Implementations§

Source§

impl<T> SignalStream<T>
where T: Clone,

Source

pub fn new(receiver: Receiver<T>, signal_id: SignalId) -> SignalStream<T>

Create a new signal stream.

Source

pub fn filter<F>(self, predicate: F) -> SignalStream<T>
where F: Fn(&T) -> bool + Send + Sync + 'static,

Add a filter to this stream.

Only values matching the predicate will be yielded.

Source

pub fn try_recv(&mut self) -> Option<T>

Try to receive the next value without blocking.

Returns None if no value is available or the channel is closed.

Source

pub async fn recv(&mut self) -> Result<T, ReactiveError>

Receive the next value, waiting if necessary.

Returns an error if the channel is closed.

Signal subscriptions are eventually consistent rather than lossless: if a subscriber lags behind the broadcast buffer under sustained load, intermediate values may be dropped and the next received value will be a newer snapshot. Handlers are expected to log lag events so the loss is diagnosable.

Auto Trait Implementations§

§

impl<T> Freeze for SignalStream<T>

§

impl<T> !RefUnwindSafe for SignalStream<T>

§

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

§

impl<T> Sync for SignalStream<T>
where T: Send,

§

impl<T> Unpin for SignalStream<T>

§

impl<T> UnsafeUnpin for SignalStream<T>

§

impl<T> !UnwindSafe for SignalStream<T>

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

Source§

type Output = T

Should always be Self
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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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