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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
use std::fmt::Debug;
use crate::{store::Store, MappedStore};
use dioxus_signals::{Readable, ReadableExt, Writable};
impl<Lens, T, E> Store<Result<T, E>, Lens>
where
Lens: Readable<Target = Result<T, E>> + 'static,
T: 'static,
E: 'static,
{
/// Checks if the `Result` is `Ok`. This will only track the shallow state of the `Result`. It will
/// only cause a re-run if the `Result` could change from `Err` to `Ok` or vice versa.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Ok::<u32, ()>(42));
/// assert!(store.is_ok());
/// ```
pub fn is_ok(&self) -> bool {
self.selector().track_shallow();
self.selector().peek().is_ok()
}
/// Returns true if the result is Ok and the closure returns true. This will always track the shallow
/// state of the and will track the inner state of the enum if the enum is Ok.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Ok::<u32, ()>(42));
/// assert!(store.is_ok_and(|v| *v == 42));
/// ```
pub fn is_ok_and(&self, f: impl FnOnce(&T) -> bool) -> bool {
self.selector().track_shallow();
let value = self.selector().peek();
if let Ok(v) = &*value {
self.selector().track();
f(v)
} else {
false
}
}
/// Checks if the `Result` is `Err`. This will only track the shallow state of the `Result`. It will
/// only cause a re-run if the `Result` could change from `Ok` to `Err` or vice versa.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Err::<(), u32>(42));
/// assert!(store.is_err());
/// ```
pub fn is_err(&self) -> bool {
self.selector().track_shallow();
self.selector().peek().is_err()
}
/// Returns true if the result is Err and the closure returns true. This will always track the shallow
/// state of the and will track the inner state of the enum if the enum is Err.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Err::<(), u32>(42));
/// assert!(store.is_err_and(|v| *v == 42));
/// ```
pub fn is_err_and(&self, f: impl FnOnce(&E) -> bool) -> bool {
self.selector().track_shallow();
let value = self.selector().peek();
if let Err(e) = &*value {
self.selector().track();
f(e)
} else {
false
}
}
/// Converts `Store<Result<T, E>>` into `Option<Store<T>>`, discarding the error if present. This will
/// only track the shallow state of the `Result`. It will only cause a re-run if the `Result` could
/// change from `Err` to `Ok` or vice versa.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Ok::<u32, ()>(42));
/// match store.ok() {
/// Some(ok_store) => assert_eq!(ok_store(), 42),
/// None => panic!("Expected Ok"),
/// }
/// ```
pub fn ok(self) -> Option<MappedStore<T, Lens>> {
let map: fn(&Result<T, E>) -> &T = |value| {
value.as_ref().unwrap_or_else(|_| {
panic!("Tried to access `ok` on an Err value");
})
};
let map_mut: fn(&mut Result<T, E>) -> &mut T = |value| {
value.as_mut().unwrap_or_else(|_| {
panic!("Tried to access `ok` on an Err value");
})
};
self.is_ok()
.then(|| self.into_selector().child(0, map, map_mut).into())
}
/// Converts `Store<Result<T, E>>` into `Option<Store<E>>`, discarding the success if present. This will
/// only track the shallow state of the `Result`. It will only cause a re-run if the `Result` could
/// change from `Ok` to `Err` or vice versa.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Err::<(), u32>(42));
/// match store.err() {
/// Some(err_store) => assert_eq!(err_store(), 42),
/// None => panic!("Expected Err"),
/// }
/// ```
pub fn err(self) -> Option<MappedStore<E, Lens>>
where
Lens: Writable<Target = Result<T, E>> + 'static,
{
self.is_err().then(|| {
let map: fn(&Result<T, E>) -> &E = |value| match value {
Ok(_) => panic!("Tried to access `err` on an Ok value"),
Err(e) => e,
};
let map_mut: fn(&mut Result<T, E>) -> &mut E = |value| match value {
Ok(_) => panic!("Tried to access `err` on an Ok value"),
Err(e) => e,
};
self.into_selector().child(1, map, map_mut).into()
})
}
/// Transposes the `Store<Result<T, E>>` into a `Result<Store<T>, Store<E>>`. This will only track the
/// shallow state of the `Result`. It will only cause a re-run if the `Result` could change from `Err` to
/// `Ok` or vice versa.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Ok::<u32, ()>(42));
/// match store.transpose() {
/// Ok(ok_store) => assert_eq!(ok_store(), 42),
/// Err(err_store) => assert_eq!(err_store(), ()),
/// }
/// ```
#[allow(clippy::result_large_err)]
pub fn transpose(self) -> Result<MappedStore<T, Lens>, MappedStore<E, Lens>>
where
Lens: Writable<Target = Result<T, E>> + 'static,
{
if self.is_ok() {
let map: fn(&Result<T, E>) -> &T = |value| match value {
Ok(t) => t,
Err(_) => panic!("Tried to access `ok` on an Err value"),
};
let map_mut: fn(&mut Result<T, E>) -> &mut T = |value| match value {
Ok(t) => t,
Err(_) => panic!("Tried to access `ok` on an Err value"),
};
Ok(self.into_selector().child(0, map, map_mut).into())
} else {
let map: fn(&Result<T, E>) -> &E = |value| match value {
Ok(_) => panic!("Tried to access `err` on an Ok value"),
Err(e) => e,
};
let map_mut: fn(&mut Result<T, E>) -> &mut E = |value| match value {
Ok(_) => panic!("Tried to access `err` on an Ok value"),
Err(e) => e,
};
Err(self.into_selector().child(1, map, map_mut).into())
}
}
/// Unwraps the `Result` and returns a `Store<T>`. This will only track the shallow state of the `Result`.
/// It will only cause a re-run if the `Result` could change from `Err` to `Ok` or vice versa.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Ok::<u32, ()>(42));
/// let unwrapped = store.unwrap();
/// assert_eq!(unwrapped(), 42);
/// ```
pub fn unwrap(self) -> MappedStore<T, Lens>
where
Lens: Writable<Target = Result<T, E>> + 'static,
E: Debug,
{
self.transpose().unwrap()
}
/// Expects the `Result` to be `Ok` and returns a `Store<T>`. If the value is `Err`, this will panic with `msg`.
/// This will only track the shallow state of the `Result`. It will only cause a re-run if the `Result` could
/// change from `Err` to `Ok` or vice versa.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Ok::<u32, ()>(42));
/// let unwrapped = store.expect("Expected Ok");
/// assert_eq!(unwrapped(), 42);
/// ```
pub fn expect(self, msg: &str) -> MappedStore<T, Lens>
where
Lens: Writable<Target = Result<T, E>> + 'static,
E: Debug,
{
self.transpose().expect(msg)
}
/// Unwraps the error variant of the `Result`. This will only track the shallow state of the `Result`.
/// It will only cause a re-run if the `Result` could change from `Ok` to `Err` or vice versa.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Err::<(), u32>(42));
/// let unwrapped_err = store.unwrap_err();
/// assert_eq!(unwrapped_err(), 42);
/// ```
pub fn unwrap_err(self) -> MappedStore<E, Lens>
where
Lens: Writable<Target = Result<T, E>> + 'static,
T: Debug,
{
self.transpose().unwrap_err()
}
/// Expects the `Result` to be `Err` and returns a `Store<E>`. If the value is `Ok`, this will panic with `msg`.
/// This will only track the shallow state of the `Result`. It will only cause a re-run if the `Result` could
/// change from `Ok` to `Err` or vice versa.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Err::<(), u32>(42));
/// let unwrapped_err = store.expect_err("Expected Err");
/// assert_eq!(unwrapped_err(), 42);
/// ```
pub fn expect_err(self, msg: &str) -> MappedStore<E, Lens>
where
Lens: Writable<Target = Result<T, E>> + 'static,
T: Debug,
{
self.transpose().expect_err(msg)
}
/// Call the function with a reference to the inner value if it is Ok. This will always track the shallow
/// state of the and will track the inner state of the enum if the enum is Ok.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Ok::<u32, ()>(42)).inspect(|v| println!("{v}"));
/// ```
pub fn inspect(self, f: impl FnOnce(&T)) -> Self
where
Lens: Writable<Target = Result<T, E>> + 'static,
{
{
self.selector().track_shallow();
let value = self.selector().peek();
if let Ok(value) = &*value {
self.selector().track();
f(value);
}
}
self
}
/// Call the function with a mutable reference to the inner value if it is Err. This will always track the shallow
/// state of the `Result` and will track the inner state of the enum if the enum is Err.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Err::<(), u32>(42)).inspect_err(|v| println!("{v}"));
/// ```
pub fn inspect_err(self, f: impl FnOnce(&E)) -> Self
where
Lens: Writable<Target = Result<T, E>> + 'static,
{
{
self.selector().track_shallow();
let value = self.selector().peek();
if let Err(value) = &*value {
self.selector().track();
f(value);
}
}
self
}
/// Transpose the store then coerce the contents of the Result with deref. This will only track the shallow state of the `Result`. It will
/// only cause a re-run if the `Result` could change from `Err` to `Ok` or vice versa.
///
/// # Example
/// ```rust, no_run
/// use dioxus_stores::*;
/// let store = use_store(|| Ok::<Box<u32>, ()>(Box::new(42)));
/// let derefed = store.as_deref().unwrap();
/// assert_eq!(derefed(), 42);
/// ```
pub fn as_deref(self) -> Result<MappedStore<T::Target, Lens>, MappedStore<E, Lens>>
where
Lens: Writable<Target = Result<T, E>> + 'static,
T: std::ops::DerefMut,
{
if self.is_ok() {
let map: fn(&Result<T, E>) -> &T::Target = |value| match value {
Ok(t) => t.deref(),
Err(_) => panic!("Tried to access `ok` on an Err value"),
};
let map_mut: fn(&mut Result<T, E>) -> &mut T::Target = |value| match value {
Ok(t) => t.deref_mut(),
Err(_) => panic!("Tried to access `ok` on an Err value"),
};
Ok(self.into_selector().child(0, map, map_mut).into())
} else {
let map: fn(&Result<T, E>) -> &E = |value| match value {
Ok(_) => panic!("Tried to access `err` on an Ok value"),
Err(e) => e,
};
let map_mut: fn(&mut Result<T, E>) -> &mut E = |value| match value {
Ok(_) => panic!("Tried to access `err` on an Ok value"),
Err(e) => e,
};
Err(self.into_selector().child(1, map, map_mut).into())
}
}
}