Mirrors/dioxus
2
0
Fork 0
mirror of https://github.com/DioxusLabs/dioxus synced 2024-11-26 22:20:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix peek spelling

Browse source
This commit is contained in:
Evan Almloff 2023-12-07 11:37:59 -06:00
parent 1c2a6fa010
commit a1550460ce
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
packages/signals/src/signal.rs
View file

@ -203,7 +203,7 @@ impl<T: 'static> Signal<T> {
self.inner.origin_scope()
}
/// Get the current value of the signal. This will subscribe the current scope to the signal. If you would like to read the signal without subscribing to it, you can use [`Self::peak`] instead.
/// Get the current value of the signal. This will subscribe the current scope to the signal. If you would like to read the signal without subscribing to it, you can use [`Self::peek`] instead.
///
/// If the signal has been dropped, this will panic.
#[track_caller]
@ -237,7 +237,7 @@ impl<T: 'static> Signal<T> {
/// Get the current value of the signal. **Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update.**
///
/// If the signal has been dropped, this will panic.
pub fn peak(&self) -> GenerationalRef<T> {
pub fn peek(&self) -> GenerationalRef<T> {
let inner = self.inner.read();
GenerationalRef::map(inner, |v| &v.value)
}
@ -428,7 +428,7 @@ impl<T: 'static> ReadOnlySignal<T> {
self.inner.origin_scope()
}
/// Get the current value of the signal. This will subscribe the current scope to the signal. If you would like to read the signal without subscribing to it, you can use [`Self::peak`] instead.
/// Get the current value of the signal. This will subscribe the current scope to the signal. If you would like to read the signal without subscribing to it, you can use [`Self::peek`] instead.
///
/// If the signal has been dropped, this will panic.
#[track_caller]
@ -439,8 +439,8 @@ impl<T: 'static> ReadOnlySignal<T> {
/// Get the current value of the signal. **Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update.**
///
/// If the signal has been dropped, this will panic.
pub fn peak(&self) -> GenerationalRef<T> {
self.inner.peak()
pub fn peek(&self) -> GenerationalRef<T> {
self.inner.peek()
}
/// Run a closure with a reference to the signal's value.