Fix #2612: adjust readable trait to allow try_peek (#2714)

* Fix #2612: adjust readable trait to allow try_peek

Our implementation for Readable was inconsistent.
We had a try_unchecked variant for read but not for peek.
This resolves that by making a breaking change to the
Readable interface.

* fix doctests too
This commit is contained in:
Jonathan Kelley authored and GitHub committed 2024-07-26 18:20:16 -05:00
1 parent 443b9a4af6
commit e42b71b1ba
13 files changed
+102 -58

No files matched your search

+3 -3
View File
@@ -10,7 +10,7 @@ use std::{
use dioxus_core::prelude::*;
use futures_util::StreamExt;
use generational_box::{AnyStorage, UnsyncStorage};
use generational_box::{AnyStorage, BorrowResult, UnsyncStorage};
struct UpdateInformation<T> {
dirty: Arc<AtomicBool>,
@@ -164,8 +164,8 @@ where
///
/// If the signal has been dropped, this will panic.
#[track_caller]
fn peek_unchecked(&self) -> ReadableRef<'static, Self> {
self.inner.peek_unchecked()
fn try_peek_unchecked(&self) -> BorrowResult<ReadableRef<'static, Self>> {
self.inner.try_peek_unchecked()
}
}