Struct kobold::stateful::Signal

source ·
#[repr(transparent)]
pub struct Signal<S> { /* private fields */ }

Implementations§

source§

impl<S> Signal<S>

source

pub fn update<F, O>(&self, mutator: F)where F: FnOnce(&mut S) -> O, O: ShouldRender,

Update the state behind this Signal.

fn example(count: Signal<i32>) {
    // increment count and trigger a render
    count.update(|count| *count += 1);

    // increment count if less than 10, only render on change
    count.update(|count| {
        if *count < 10 {
            *count += 1;
            Then::Render
        } else {
            Then::Stop
        }
    })
}
source

pub fn update_silent<F>(&self, mutator: F)where F: FnOnce(&mut S),

Same as update, but it never renders updates.

source

pub fn set(&self, val: S)

Replace the entire state with a new value and trigger an update.

Trait Implementations§

source§

impl<S> Clone for Signal<S>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for Signal<S>

§

impl<S> !Send for Signal<S>

§

impl<S> !Sync for Signal<S>

§

impl<S> Unpin for Signal<S>

§

impl<S> !UnwindSafe for Signal<S>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.