Struct kobold::stateful::Hook

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

A hook into some state S. A reference to Hook is obtained by using the stateful function.

Hook can be read from though its Deref implementation, and it allows for mutations either by binding closures to it.

Implementations

impl<S> Hook<S>

pub fn bind<E, F, O>(&self, callback: F) -> Bound<'_, S, F>where S: 'static, E: EventCast, F: Fn(&mut S, E) -> O + 'static, O: ShouldRender,

Binds a closure to a mutable reference of the state. While this method is public it’s recommended to use the bind! macro instead.

pub fn bind_async<E, F, T>(&self, callback: F) -> impl Listener<E>where S: 'static, E: EventCast, F: Fn(Signal<S>, E) -> T + 'static, T: Future<Output = ()> + 'static,

pub fn get(&self) -> Swhere S: Copy,

Get the value of state if state implements Copy. This is equivalent to writing **hook but conveys intent better.

Trait Implementations

impl<S> Deref for Hook<S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, V> View for &'a Hook<V>where &'a V: View + 'a,

type Product = <&'a V as View>::Product

The product should contain a DOM reference to this View and any data it needs to update itself.

fn build(self, p: In<'_, Self::Product>) -> Out<'_, Self::Product>

Build a product that can be mounted in the DOM from this type.

fn update(self, p: &mut Self::Product)

Update the product and apply changes to the DOM if necessary.

fn on_mount<F>(self, handler: F) -> OnMount<Self, F>where F: FnOnce(&<Self::Product as Mountable>::Js), Self: Sized,

Once this view is built, do something once.

fn on_render<F>(self, handler: F) -> OnRender<Self, F>where F: FnOnce(&<Self::Product as Mountable>::Js), Self: Sized,

Similar to on_mount but triggers on every update, not just initial render.