Struct relm4::shared_state::Reducer

source ·
pub struct Reducer<Data: Reducible> { /* private fields */ }
Expand description

A type that allows you to share information across your application easily.

Reducers receive messages, update their state accordingly and notify their subscribers.

Unlike SharedState, this type doesn’t allow direct access to the internal data. Instead, it updates its state after receiving messages, similar to components. After the message is processed, all subscribers will be notified.

Example

use relm4::{Reducer, Reducible};

struct CounterReducer(u8);

enum CounterInput {
    Increment,
    Decrement,
}

impl Reducible for CounterReducer {
    type Input = CounterInput;

    fn init() -> Self {
        Self(0)
    }

    fn reduce(&mut self, input: Self::Input) -> bool {
        match input {
            CounterInput::Increment => {
                self.0 += 1;
            }
            CounterInput::Decrement =>  {
                self.0 -= 1;
            }
        }
        true
    }
}

// Create the reducer.
static REDUCER: Reducer<CounterReducer> = Reducer::new();

// Update the reducer.
REDUCER.emit(CounterInput::Increment);

// Create a channel and subscribe to changes.
let (sender, receiver) = relm4::channel();
REDUCER.subscribe(&sender, |data| data.0);

// Count up to 2.
REDUCER.emit(CounterInput::Increment);
assert_eq!(receiver.recv_sync().unwrap(), 2);

Implementations§

Create a new Reducer variable.

The data will be initialized lazily on the first access.

Subscribe to a Reducer. Any subscriber will be notified with a message every time you modify the reducer (by calling Self::emit()).

An alternative version of subscribe() that only send a message if the closure returns Some.

Sends a message to the reducer to update its state.

If the Reducible::reduce() method returns true, all subscribers will be notified.

Trait Implementations§

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Returns the position. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Returns the position. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more