Struct Radio

pub struct Radio<Value, Channel>
where
    Channel: RadioChannel<Value>,
    Value: 'static,
{ /* private fields */ }

Radio lets you access the state and is subscribed given it’s Channel.

Implementations

impl<Value, Channel> Radio<Value, Channel>

where Channel: RadioChannel<Value>,

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

Read the current state value.

Example:

let value = radio.read();

pub fn with(&self, cb: impl FnOnce(ReadRef<'_, Value>))

Read the current state value inside a callback.

Example:

radio.with(|value| {
    // Do something with `value`
});

pub fn write(&mut self) -> RadioGuard<Value, Channel>

Modify the state using the channel this radio was created with.

Example:

radio.write().value = 1;

pub fn write_with(&mut self, cb: impl FnOnce(RadioGuard<Value, Channel>))

Get a mutable reference to the current state value, inside a callback.

Example:

radio.write_with(|value| {
    // Modify `value`
});

pub fn write_channel(&mut self, channel: Channel) -> RadioGuard<Value, Channel>

Modify the state using a custom Channel.

Example:

radio.write(Channel::Whatever).value = 1;

pub fn write_channel_with( &mut self, channel: Channel, cb: impl FnOnce(RadioGuard<Value, Channel>), )

Get a mutable reference to the current state value, inside a callback.

Example:

radio.write_channel_with(Channel::Whatever, |value| {
    // Modify `value`
});

pub fn write_with_channel_selection( &mut self, cb: impl FnOnce(&mut Value) -> ChannelSelection<Channel>, ) -> ChannelSelection<Channel>

Get a mutable reference to the current state value, inside a callback that returns the channel to be used.

Example:

radio.write_with_channel_selection(|value| {
    // Modify `value`
    if value.cool {
        ChannelSelection::Select(Channel::Whatever)
    } else {
        ChannelSelection::Silence
    }
});

pub fn write_silently(&mut self) -> RadioGuard<Value, Channel>

Modify the state silently, no component will be notified.

This is not recommended, the only intended usage for this is inside RadioAsyncReducer.

Trait Implementations

impl<Value, Channel> Clone for Radio<Value, Channel>

where Channel: RadioChannel<Value>,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Value, Channel> MutView<'static, Value> for Radio<Value, Channel>

where Channel: RadioChannel<Value>,

fn read(&mut self) -> ReadRef<'static, Value>

fn peek(&mut self) -> ReadRef<'static, Value>

fn write(&mut self) -> WriteRef<'static, Value>

fn write_if(&mut self, with: impl FnOnce(WriteRef<'static, Value>) -> bool)

impl<Value, Channel> PartialEq for Radio<Value, Channel>

where Channel: RadioChannel<Value>,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Data: DataAsyncReducer<Channel = Channel, Action = Action>, Channel: RadioChannel<Data>, Action> RadioAsyncReducer for Radio<Data, Channel>

type Action = Action

fn async_apply(&mut self, action: Self::Action)

where Self::Action: 'static,

impl<Data: DataReducer<Channel = Channel, Action = Action>, Channel: RadioChannel<Data>, Action> RadioReducer for Radio<Data, Channel>

type Action = Action

type Channel = Channel

fn apply(&mut self, action: Action) -> ChannelSelection<Channel>

impl<Value, Channel> Copy for Radio<Value, Channel>

where Channel: RadioChannel<Value>,