Readable and Writable helpers for String, HashMap and HashSet (#4834)

* Add more read/write methods for string signals

* add helpers for HashMap and HashSet as well

* fix typo

* fix conflicting string and str extensions

* fix counters example

packages/signals/src/lib.rs

@@ -44,3 +44,32 @@ pub mod warnings;
 
 mod boxed;
 pub use boxed::*;
+
+/// A macro to define extension methods for signal types that call the method with either `with` or `with_mut` depending on the mutability of self.
+macro_rules! ext_methods {
+    (
+        $(
+            $(#[$meta:meta])*
+            fn $name:ident $(<$($gen:tt),*>)? (&$($self:ident)+ $(, $arg_name:ident: $arg_type:ty )* ) $(-> $ret:ty)? = $expr:expr;
+        )*
+    ) => {
+        $(
+            $(#[$meta])*
+            #[track_caller]
+            fn $name$(<$($gen),*>)? (& $($self)+ $(, $arg_name: $arg_type )* ) $(-> $ret)?
+            {
+                ext_methods!(@with $($self)+, $($arg_name),*; $expr)
+            }
+        )*
+    };
+
+    (@with mut $self:ident, $($arg_name:ident),*; $expr:expr) => {
+        $self.with_mut(|_self| ($expr)(_self, $($arg_name),*))
+    };
+
+    (@with $self:ident, $($arg_name:ident),*; $expr:expr) => {
+        $self.with(|_self| ($expr)(_self, $($arg_name),*))
+    };
+}
+
+pub(crate) use ext_methods;

packages/signals/src/read.rs

@@ -1,10 +1,13 @@
-use std::{mem::MaybeUninit, ops::Index};
+use std::collections::{HashMap, HashSet};
+use std::{
+    mem::MaybeUninit,
+    ops::{Deref, Index},
+};
 
+use crate::{ext_methods, MappedSignal, ReadSignal};
 use dioxus_core::Subscribers;
 use generational_box::{AnyStorage, UnsyncStorage};
 
-use crate::{MappedSignal, ReadSignal};
-
 /// A reference to a value that can be read from.
 #[allow(type_alias_bounds)]
 pub type ReadableRef<'a, T: Readable, O = <T as Readable>::Target> =
@@ -423,3 +426,99 @@ pub trait ReadableResultExt<T, E>: Readable<Target = Result<T, E>> {
 }
 
 impl<T, E, R> ReadableResultExt<T, E> for R where R: Readable<Target = Result<T, E>> {}
+
+/// An extension trait for [`Readable<String>`] that provides some convenience methods.
+pub trait ReadableStringExt: Readable<Target = String> {
+    ext_methods! {
+        /// Check the capacity of the string.
+        fn capacity(&self) -> usize = String::capacity;
+    }
+}
+
+impl<W> ReadableStringExt for W where W: Readable<Target = String> {}
+
+/// An extension trait for [`Readable<String>`] and [`Readable<str>`] that provides some convenience methods.
+pub trait ReadableStrExt: Readable<Target: Deref<Target = str> + 'static> {
+    ext_methods! {
+        /// Check if the string is empty.
+        fn is_empty(&self) -> bool = |s: &Self::Target| s.deref().is_empty();
+
+        /// Get the length of the string.
+        fn len(&self) -> usize = |s: &Self::Target| s.deref().len();
+
+        /// Check if the string contains the given pattern.
+        fn contains(&self, pat: &str) -> bool = |s: &Self::Target, pat| s.deref().contains(pat);
+    }
+}
+
+impl<W> ReadableStrExt for W where W: Readable<Target: Deref<Target = str> + 'static> {}
+
+/// An extension trait for [`Readable<HashMap<K, V, H>>`] that provides some convenience methods.
+pub trait ReadableHashMapExt<K: 'static, V: 'static, H: 'static>:
+    Readable<Target = HashMap<K, V, H>>
+{
+    ext_methods! {
+        /// Check if the hashmap is empty.
+        fn is_empty(&self) -> bool = HashMap::is_empty;
+
+        /// Get the length of the hashmap.
+        fn len(&self) -> usize = HashMap::len;
+
+        /// Get the capacity of the hashmap.
+        fn capacity(&self) -> usize = HashMap::capacity;
+    }
+
+    /// Get the value for the given key.
+    #[track_caller]
+    fn get(&self, key: &K) -> Option<ReadableRef<'_, Self, V>>
+    where
+        K: std::hash::Hash + Eq,
+        H: std::hash::BuildHasher,
+    {
+        <Self::Storage as AnyStorage>::try_map(self.read(), |v| v.get(key))
+    }
+
+    /// Check if the hashmap contains the given key.
+    #[track_caller]
+    fn contains_key(&self, key: &K) -> bool
+    where
+        K: std::hash::Hash + Eq,
+        H: std::hash::BuildHasher,
+    {
+        self.with(|v| v.contains_key(key))
+    }
+}
+
+impl<K: 'static, V: 'static, H: 'static, R> ReadableHashMapExt<K, V, H> for R where
+    R: Readable<Target = HashMap<K, V, H>>
+{
+}
+
+/// An extension trait for [`Readable<HashSet<V, H>>`] that provides some convenience methods.
+pub trait ReadableHashSetExt<V: 'static, H: 'static>: Readable<Target = HashSet<V, H>> {
+    ext_methods! {
+        /// Check if the hashset is empty.
+        fn is_empty(&self) -> bool = HashSet::is_empty;
+
+        /// Get the length of the hashset.
+        fn len(&self) -> usize = HashSet::len;
+
+        /// Get the capacity of the hashset.
+        fn capacity(&self) -> usize = HashSet::capacity;
+    }
+
+    /// Check if the hashset contains the given value.
+    #[track_caller]
+    fn contains(&self, value: &V) -> bool
+    where
+        V: std::hash::Hash + Eq,
+        H: std::hash::BuildHasher,
+    {
+        self.with(|v| v.contains(value))
+    }
+}
+
+impl<V: 'static, H: 'static, R> ReadableHashSetExt<V, H> for R where
+    R: Readable<Target = HashSet<V, H>>
+{
+}

packages/signals/src/write.rs

@@ -1,8 +1,11 @@
-use std::ops::{Deref, DerefMut, IndexMut};
+use std::{
+    collections::{HashMap, HashSet},
+    ops::{Deref, DerefMut, IndexMut},
+};
 
 use generational_box::{AnyStorage, UnsyncStorage};
 
-use crate::{read::Readable, read::ReadableExt, MappedMutSignal, WriteSignal};
+use crate::{ext_methods, read::Readable, read::ReadableExt, MappedMutSignal, WriteSignal};
 
 /// A reference to a value that can be written to.
 #[allow(type_alias_bounds)]
@@ -59,7 +62,7 @@ pub trait Writable: Readable {
 /// # use dioxus::prelude::*;
 /// fn app() -> Element {
 ///     let mut value = use_signal(|| String::from("hello"));
-///     
+///
 ///     rsx! {
 ///         button {
 ///             onclick: move |_| {
@@ -578,4 +581,148 @@ impl<'a, T: 'static, R: Writable<Target = Vec<T>>> Iterator for WritableValueIte
     }
 }
 
-impl<T, W> WritableVecExt<T> for W where W: Writable<Target = Vec<T>> {}
+impl<W, T> WritableVecExt<T> for W where W: Writable<Target = Vec<T>> {}
+
+/// An extension trait for [`Writable<String>`] that provides some convenience methods.
+pub trait WritableStringExt: Writable<Target = String> {
+    ext_methods! {
+        /// Pushes a character to the end of the string.
+        fn push_str(&mut self, s: &str) = String::push_str;
+
+        /// Pushes a character to the end of the string.
+        fn push(&mut self, c: char) = String::push;
+
+        /// Pops a character from the end of the string.
+        fn pop(&mut self) -> Option<char> = String::pop;
+
+        /// Inserts a string at the given index.
+        fn insert_str(&mut self, idx: usize, s: &str) = String::insert_str;
+
+        /// Inserts a character at the given index.
+        fn insert(&mut self, idx: usize, c: char) = String::insert;
+
+        /// Remove a character at the given index
+        fn remove(&mut self, idx: usize) -> char = String::remove;
+
+        /// Replace a range of the string with the given string.
+        fn replace_range(&mut self, range: impl std::ops::RangeBounds<usize>, replace_with: &str) = String::replace_range;
+
+        /// Clears the string, removing all characters.
+        fn clear(&mut self) = String::clear;
+
+        /// Extends the string with the given iterator of characters.
+        fn extend(&mut self, iter: impl IntoIterator<Item = char>) = String::extend;
+
+        /// Truncates the string to the given length.
+        fn truncate(&mut self, len: usize) = String::truncate;
+
+        /// Splits the string off at the given index, returning the tail as a new string.
+        fn split_off(&mut self, at: usize) -> String = String::split_off;
+    }
+}
+
+impl<W> WritableStringExt for W where W: Writable<Target = String> {}
+
+/// An extension trait for [`Writable<HashMap<K, V, H>>`] that provides some convenience methods.
+pub trait WritableHashMapExt<K: 'static, V: 'static, H: 'static>:
+    Writable<Target = HashMap<K, V, H>>
+{
+    ext_methods! {
+        /// Clears the map, removing all key-value pairs.
+        fn clear(&mut self) = HashMap::clear;
+
+        /// Retains only the key-value pairs that match the given predicate.
+        fn retain(&mut self, f: impl FnMut(&K, &mut V) -> bool) = HashMap::retain;
+    }
+
+    /// Inserts a key-value pair into the map. If the key was already present, the old value is returned.
+    #[track_caller]
+    fn insert(&mut self, k: K, v: V) -> Option<V>
+    where
+        K: std::cmp::Eq + std::hash::Hash,
+        H: std::hash::BuildHasher,
+    {
+        self.with_mut(|map: &mut HashMap<K, V, H>| map.insert(k, v))
+    }
+
+    /// Extends the map with the key-value pairs from the given iterator.
+    #[track_caller]
+    fn extend(&mut self, iter: impl IntoIterator<Item = (K, V)>)
+    where
+        K: std::cmp::Eq + std::hash::Hash,
+        H: std::hash::BuildHasher,
+    {
+        self.with_mut(|map: &mut HashMap<K, V, H>| map.extend(iter))
+    }
+
+    /// Removes a key from the map, returning the value at the key if the key was previously in the map.
+    #[track_caller]
+    fn remove(&mut self, k: &K) -> Option<V>
+    where
+        K: std::cmp::Eq + std::hash::Hash,
+        H: std::hash::BuildHasher,
+    {
+        self.with_mut(|map: &mut HashMap<K, V, H>| map.remove(k))
+    }
+
+    /// Get a mutable reference to the value at the given key.
+    #[track_caller]
+    fn get_mut(&mut self, k: &K) -> Option<WritableRef<'_, Self, V>>
+    where
+        K: std::cmp::Eq + std::hash::Hash,
+        H: std::hash::BuildHasher,
+    {
+        WriteLock::filter_map(self.write(), |map: &mut HashMap<K, V, H>| map.get_mut(k))
+    }
+}
+
+impl<K: 'static, V: 'static, H: 'static, R> WritableHashMapExt<K, V, H> for R where
+    R: Writable<Target = HashMap<K, V, H>>
+{
+}
+
+/// An extension trait for [`Writable<HashSet<V, H>>`] that provides some convenience methods.
+pub trait WritableHashSetExt<V: 'static, H: 'static>: Writable<Target = HashSet<V, H>> {
+    ext_methods! {
+        /// Clear the hash set.
+        fn clear(&mut self) = HashSet::clear;
+
+        /// Retain only the elements specified by the predicate.
+        fn retain(&mut self, f: impl FnMut(&V) -> bool) = HashSet::retain;
+    }
+
+    /// Inserts a value into the set. Returns true if the value was not already present.
+    #[track_caller]
+    fn insert(&mut self, k: V) -> bool
+    where
+        V: std::cmp::Eq + std::hash::Hash,
+        H: std::hash::BuildHasher,
+    {
+        self.with_mut(|set| set.insert(k))
+    }
+
+    /// Extends the set with the values from the given iterator.
+    #[track_caller]
+    fn extend(&mut self, iter: impl IntoIterator<Item = V>)
+    where
+        V: std::cmp::Eq + std::hash::Hash,
+        H: std::hash::BuildHasher,
+    {
+        self.with_mut(|set| set.extend(iter))
+    }
+
+    /// Removes a value from the set. Returns true if the value was present.
+    #[track_caller]
+    fn remove(&mut self, k: &V) -> bool
+    where
+        V: std::cmp::Eq + std::hash::Hash,
+        H: std::hash::BuildHasher,
+    {
+        self.with_mut(|set| set.remove(k))
+    }
+}
+
+impl<V: 'static, H: 'static, R> WritableHashSetExt<V, H> for R where
+    R: Writable<Target = HashSet<V, H>>
+{
+}