Struct StreamSignal 

pub struct StreamSignal<T> { /* private fields */ }

A reactive signal for streams that produce multiple values.

StreamSignal provides a way to reactively consume values from async streams and automatically update UI when new values arrive. It manages the stream lifecycle and provides access to both the current value and completion state.

Examples

// Simple case: event loop executor, returns StreamSignal<Option<T>>
let stream_signal = StreamSignal::new(my_stream);

// With initial value
let stream_signal = StreamSignal::with_initial(my_stream, initial_value);

// Full customization
let stream_signal = StreamSignal::custom(my_stream)
    .tokio_spawn()
    .initial(initial_value)
    .build();

Implementations

impl<T: 'static> StreamSignal<T>

pub fn new<S>(stream: S) -> StreamSignal<Option<T>>

where S: Stream<Item = T> + 'static, T: 'static,

Creates a new reactive stream signal with sensible defaults.

• Executor: Main event loop (stream does not need to be Send)
• Initial value: None (returns StreamSignal<Option<U>>)

Parameters

• stream - The async stream to consume.

Examples

let stream_signal = StreamSignal::new(my_stream);

pub fn with_initial<S>(stream: S, initial: T) -> Self

where S: Stream<Item = T> + 'static,

Creates a new reactive stream signal with an initial value.

Uses the same defaults as new() but allows you to specify an initial value so the signal is never None.

• Executor: Main event loop (stream does not need to be Send)

Parameters

• stream - The async stream to consume.
• initial - The initial value for the signal before any stream item arrives.

Examples

let stream_signal = StreamSignal::with_initial(my_stream, initial_value);

pub fn custom<S>( stream: S, ) -> StreamSignalBuilder<S, T, EventLoopExecutor, NoInitial>

where S: Stream<Item = T> + 'static, T: 'static,

Creates a stream signal builder for full customization.

Use this when you need to customize:

• The executor (tokio, custom, etc.)
• Initial value

Examples

// Tokio executor with initial value
let stream_signal = StreamSignal::custom(my_stream)
    .tokio_spawn()
    .initial(initial_value)
    .build();

pub fn is_finished(&self) -> bool

Trait Implementations

impl<T> Clone for StreamSignal<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: 'static, S> From<S> for StreamSignal<Option<T>>

where S: Stream<Item = T> + 'static,

This implementation will be removed in the future

fn from(value: S) -> Self

Converts to this type from the input type.

impl<T> SignalGet<T> for StreamSignal<T>

where T: Clone,

fn id(&self) -> ReactiveId

get the Signal Id

fn get_untracked(&self) -> T

where T: 'static,

fn get(&self) -> T

where T: 'static,

fn try_get(&self) -> Option<T>

where T: 'static,

fn try_get_untracked(&self) -> Option<T>

where T: 'static,

impl<T> SignalRead<T> for StreamSignal<T>

fn id(&self) -> ReactiveId

get the Signal Id

fn try_read(&self) -> Option<ReadRef<'_, T>>

where T: 'static,

If the signal isn’t disposed, reads the data stored in the Signal and subscribes to the current running effect.

fn try_read_untracked(&self) -> Option<ReadRef<'_, T>>

where T: 'static,

If the signal isn’t disposed, reads the data stored in the Signal without subscribing.

fn read(&self) -> ReadRef<'_, T>

where T: 'static,

Reads the data stored in the Signal, subscribing the current running effect.

fn read_untracked(&self) -> ReadRef<'_, T>

where T: 'static,

Reads the data stored in the Signal without subscribing.

impl<T> SignalTrack<T> for StreamSignal<T>

fn id(&self) -> ReactiveId

fn track(&self)

Only subscribes to the current running effect to this Signal.

fn try_track(&self)

If the signal isn’t disposed,

impl<T> SignalWith<T> for StreamSignal<T>

fn id(&self) -> ReactiveId

get the Signal Id

fn with<O>(&self, f: impl FnOnce(&T) -> O) -> O

where T: 'static,

fn with_untracked<O>(&self, f: impl FnOnce(&T) -> O) -> O

where T: 'static,

fn try_with<O>(&self, f: impl FnOnce(Option<&T>) -> O) -> O

where T: 'static,

fn try_with_untracked<O>(&self, f: impl FnOnce(Option<&T>) -> O) -> O

where T: 'static,

impl<T> Copy for StreamSignal<T>