freya_radio::hooks

Struct RadioStation

Source 
pub struct RadioStation<Value, Channel>
where
    Channel: RadioChannel<Value>,
    Value: 'static,
{ /* private fields */ }
Expand description

Holds a global state and all its subscribers.

Implementations§

Source§

impl<Value, Channel> RadioStation<Value, Channel>
where Channel: RadioChannel<Value>,

Source

pub fn create_global(init_value: Value) -> Self

Create a RadioStation expected to live until the end of the process.

Source

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

Read the current state value. This effectively subscribes to any change no matter the channel.

Example:

let value = radio.read();
Source

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

Read the current state value without subscribing.

Example:

let value = radio.peek();
Source

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

Modify the state using a custom Channel.

§Example:
radio_station.write(Channel::Whatever).value = 1;

Trait Implementations§

Source§

impl<Value, Channel> Clone for RadioStation<Value, Channel>
where Channel: RadioChannel<Value>,

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<Value, Channel> Copy for RadioStation<Value, Channel>
where Channel: RadioChannel<Value>,

Auto Trait Implementations§

§

impl<Value, Channel> Freeze for RadioStation<Value, Channel>

§

impl<Value, Channel> !RefUnwindSafe for RadioStation<Value, Channel>

§

impl<Value, Channel> !Send for RadioStation<Value, Channel>

§

impl<Value, Channel> !Sync for RadioStation<Value, Channel>

§

impl<Value, Channel> Unpin for RadioStation<Value, Channel>
where Value: Unpin, Channel: Unpin,

§

impl<Value, Channel> !UnwindSafe for RadioStation<Value, Channel>

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more