hooks 2.3.0-alpha

Compile-time, async hooks
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

use std::marker::PhantomData;

use super::{
    PollNextUpdateFromStateUpdater, State, StateUninitialized, StateUpdater,
    STAGING_STATES_DEFAULT_STACK_COUNT,
};

pub struct UseState<'a, T: PollNextUpdateFromStateUpdater<EQ>, const N: usize, const EQ: bool>(
    T,
    PhantomData<&'a ()>,
);

hooks_core::impl_hook![
    type For<'a, T: PollNextUpdateFromStateUpdater<EQ>, const N: usize, const EQ: bool> =
        UseState<'a, T, N, EQ>;

    #[inline]
    fn into_hook(self) -> State<'a, T, N, EQ> {
        State::new(self.0)
    }

    #[inline(always)]
    fn update_hook(self, _hook: _) {}

    fn h(self, hook: StateUninitialized<'a, T, N, EQ>) -> (&mut T, &StateUpdater<'a, T, N>) {
        let hook = hook.get_mut();
        (
            hook.current_state.get_or_insert(self.0),
            &hook.state_updater,
        )
    }
];

pub struct UseStateWith<'a, F, const N: usize, const EQ: bool>(F, PhantomData<&'a ()>);

hooks_core::impl_hook![
    type For<
        'a,
        T: PollNextUpdateFromStateUpdater<EQ>,
        F: FnOnce() -> T,
        const N: usize,
        const EQ: bool,
    > = UseStateWith<'a, F, N, EQ>;

    #[inline]
    fn into_hook(self) -> State<'a, T, N, EQ> {
        State::new(self.0())
    }

    #[inline(always)]
    fn update_hook(self, _hook: _) {}

    fn h(self, hook: StateUninitialized<'a, T, N, EQ>) -> (&mut T, &StateUpdater<'a, T, N>) {
        let hook = hook.get_mut();
        (
            hook.current_state.get_or_insert_with(self.0),
            &hook.state_updater,
        )
    }
];

#[inline(always)]
pub fn use_state<'a, T>(
    initial_value: T,
) -> UseState<'a, T, STAGING_STATES_DEFAULT_STACK_COUNT, false> {
    UseState(initial_value, PhantomData)
}

#[inline(always)]
pub fn use_state_n<'a, T, const N: usize>(initial_value: T) -> UseState<'a, T, N, false> {
    UseState(initial_value, PhantomData)
}

/// [`use_state`] with a lazy initializer.
///
/// ```
/// # use hooks::prelude::*;
/// hook_fn!(
///     fn use_demo_state_with() -> &'hook i32 {
///         let (state, updater) = h![use_state_with(|| 1)];
///         if *state < 2 {
///             updater.replace_with_fn_pointer(|v| *v + 1);
///         }
///         state
///     }
/// );
///
/// let mut running_hook = use_demo_state_with().into_hook();
///
/// # futures_lite::future::block_on(async {
/// assert_eq!(running_hook.next_value().await, Some(&1));
/// assert_eq!(running_hook.next_value().await, Some(&2));
/// assert_eq!(running_hook.next_value().await, None);
/// # })
/// ```
#[inline(always)]
pub fn use_state_with<'a, T>(
    get_initial_value: impl FnOnce() -> T,
) -> UseStateWith<'a, impl FnOnce() -> T, STAGING_STATES_DEFAULT_STACK_COUNT, false> {
    UseStateWith(get_initial_value, PhantomData)
}

/// [`use_state_n`] with a lazy initializer.
#[inline(always)]
pub fn use_state_n_with<'a, T, const N: usize>(
    get_initial_value: impl FnOnce() -> T,
) -> UseStateWith<'a, impl FnOnce() -> T, N, false> {
    UseStateWith(get_initial_value, PhantomData)
}

#[inline(always)]
pub fn use_state_eq<'a, T: PartialEq>(
    initial_value: T,
) -> UseState<'a, T, STAGING_STATES_DEFAULT_STACK_COUNT, true> {
    UseState(initial_value, PhantomData)
}

#[inline(always)]
pub fn use_state_eq_n<'a, T: PartialEq, const N: usize>(
    initial_value: T,
) -> UseState<'a, T, N, true> {
    UseState(initial_value, PhantomData)
}

#[inline(always)]
pub fn use_state_eq_with<'a, T: PartialEq>(
    get_initial_value: impl FnOnce() -> T,
) -> UseStateWith<'a, impl FnOnce() -> T, STAGING_STATES_DEFAULT_STACK_COUNT, true> {
    UseStateWith(get_initial_value, PhantomData)
}

#[inline(always)]
pub fn use_state_eq_n_with<'a, T: PartialEq, const N: usize>(
    get_initial_value: impl FnOnce() -> T,
) -> UseStateWith<'a, impl FnOnce() -> T, N, true> {
    UseStateWith(get_initial_value, PhantomData)
}