ChannelSignal

Struct ChannelSignal 

Source
pub struct ChannelSignal<T, E> { /* private fields */ }
Expand description

A reactive signal for channels that produce multiple values with error handling.

ChannelSignal provides a way to reactively consume values from channels and automatically update UI when new values arrive or errors occur. It manages the channel lifecycle and provides access to both the current value and any errors.

§Examples

// Simple case: std::thread executor, returns ChannelSignal<Option<T>, E>
let channel_signal = ChannelSignal::new(receiver);

// With initial value
let channel_signal = ChannelSignal::with_initial(receiver, initial_value);

// Full customization
let channel_signal = ChannelSignal::custom(receiver)
    .event_loop()
    .initial(initial_value)
    .build();

Implementations§

Source§

impl<T: Send + 'static, E: Send + 'static> ChannelSignal<T, E>

Source

pub fn new<R>(receiver: R) -> ChannelSignal<Option<T>, E>
where R: BlockingReceiver<Item = T, Error = E> + Send + 'static,

Creates a new reactive channel signal with sensible defaults.

  • Executor: Std::thread for blocking receivers, event loop for pollable receivers
  • Initial value: None (returns ChannelSignal<Option<U>, E>)
§Parameters
  • receiver - The channel receiver to consume.
§Examples
let channel_signal = ChannelSignal::new(receiver);
Source

pub fn new_poll<R>(receiver: R) -> ChannelSignal<Option<T>, E>
where R: PollableReceiver<Item = T, Error = E> + Send + 'static,

Source

pub fn with_initial<R>(receiver: R, initial: T) -> Self
where R: BlockingReceiver<Item = T, Error = E> + Send + 'static,

Creates a new reactive channel 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: Std::thread for blocking receivers, event loop for pollable receivers
§Parameters
  • receiver - The channel receiver to consume.
  • initial - The initial value for the signal before any message arrives.
§Examples
let channel_signal = ChannelSignal::with_initial(receiver, initial_value);
Source

pub fn custom<R>( receiver: R, ) -> ChannelSignalBuilder<R, T, E, StdThreadExecutor, NoInitial>
where T: Send + 'static, E: Send + 'static,

Creates a channel signal builder for full customization.

Use this when you need to customize:

  • The executor (event loop, tokio, std::thread, etc.)
  • Initial value
§Examples
// Event loop executor with initial value
let channel_signal = ChannelSignal::custom(receiver)
    .event_loop()
    .initial(initial_value)
    .build();
Source

pub fn error(&self) -> ReadSignal<Option<E>>

Trait Implementations§

Source§

impl<T, E> Clone for ChannelSignal<T, E>

Source§

fn clone(&self) -> Self

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
Source§

impl<T: Send + 'static> From<Receiver<T>> for ChannelSignal<Option<T>, RecvError>

This implementation will be removed in the future

Source§

fn from(value: Receiver<T>) -> Self

Converts to this type from the input type.
Source§

impl<T, E> SignalGet<T> for ChannelSignal<T, E>
where T: Clone,

Source§

fn id(&self) -> ReactiveId

get the Signal Id
Source§

fn get_untracked(&self) -> T
where T: 'static,

Source§

fn get(&self) -> T
where T: 'static,

Source§

fn try_get(&self) -> Option<T>
where T: 'static,

Source§

fn try_get_untracked(&self) -> Option<T>
where T: 'static,

Source§

impl<T, E> SignalRead<T> for ChannelSignal<T, E>

Source§

fn id(&self) -> ReactiveId

get the Signal Id
Source§

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.
Source§

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.
Source§

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

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

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

Reads the data stored in the Signal without subscribing.
Source§

impl<T, E> SignalTrack<T> for ChannelSignal<T, E>

Source§

fn id(&self) -> ReactiveId

Source§

fn track(&self)

Only subscribes to the current running effect to this Signal.
Source§

fn try_track(&self)

If the signal isn’t disposed,
Source§

impl<T, E> SignalWith<T> for ChannelSignal<T, E>

Source§

fn id(&self) -> ReactiveId

get the Signal Id
Source§

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

Source§

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

Source§

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

Source§

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

Source§

impl<T, E> Copy for ChannelSignal<T, E>

Auto Trait Implementations§

§

impl<T, E> Freeze for ChannelSignal<T, E>

§

impl<T, E> RefUnwindSafe for ChannelSignal<T, E>

§

impl<T, E> !Send for ChannelSignal<T, E>

§

impl<T, E> !Sync for ChannelSignal<T, E>

§

impl<T, E> Unpin for ChannelSignal<T, E>
where T: Unpin, E: Unpin,

§

impl<T, E> UnwindSafe for ChannelSignal<T, E>
where T: UnwindSafe, E: UnwindSafe,

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,

Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,