reactive_stores/

arc_field.rs

use crate::{
    path::{StorePath, StorePathSegment},
    ArcStore, AtIndex, AtKeyed, DerefedField, KeyMap, KeyedSubfield, Store,
    StoreField, StoreFieldTrigger, Subfield,
};
use reactive_graph::{
    owner::Storage,
    traits::{
        DefinedAt, IsDisposed, Notify, ReadUntracked, Track, UntrackableGuard,
        Write,
    },
};
use std::{
    fmt::Debug,
    hash::Hash,
    ops::{Deref, DerefMut, IndexMut},
    panic::Location,
    sync::Arc,
};

/// Reference-counted access to a single field of type `T`.
///
/// This can be used to erase the chain of field-accessors, to make it easier to pass this into
/// another component or function without needing to specify the full type signature.
pub struct ArcField<T>
where
    T: 'static,
{
    #[cfg(any(debug_assertions, leptos_debuginfo))]
    defined_at: &'static Location<'static>,
    path: Arc<dyn Fn() -> StorePath + Send + Sync>,
    get_trigger: Arc<dyn Fn(StorePath) -> StoreFieldTrigger + Send + Sync>,
    read: Arc<dyn Fn() -> Option<StoreFieldReader<T>> + Send + Sync>,
    pub(crate) write:
        Arc<dyn Fn() -> Option<StoreFieldWriter<T>> + Send + Sync>,
    keys: Arc<dyn Fn() -> Option<KeyMap> + Send + Sync>,
    track_field: Arc<dyn Fn() + Send + Sync>,
    notify: Arc<dyn Fn() + Send + Sync>,
}

impl<T> Debug for ArcField<T>
where
    T: 'static,
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let mut f = f.debug_struct("ArcField");
        #[cfg(any(debug_assertions, leptos_debuginfo))]
        let f = f.field("defined_at", &self.defined_at);
        f.finish_non_exhaustive()
    }
}

pub struct StoreFieldReader<T>(Box<dyn Deref<Target = T>>);

impl<T> StoreFieldReader<T> {
    pub fn new(inner: impl Deref<Target = T> + 'static) -> Self {
        Self(Box::new(inner))
    }
}

impl<T> Deref for StoreFieldReader<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        self.0.deref()
    }
}

pub struct StoreFieldWriter<T>(Box<dyn UntrackableGuard<Target = T>>);

impl<T> StoreFieldWriter<T> {
    pub fn new(inner: impl UntrackableGuard<Target = T> + 'static) -> Self {
        Self(Box::new(inner))
    }
}

impl<T> Deref for StoreFieldWriter<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        self.0.deref()
    }
}

impl<T> DerefMut for StoreFieldWriter<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.0.deref_mut()
    }
}

impl<T> UntrackableGuard for StoreFieldWriter<T> {
    fn untrack(&mut self) {
        self.0.untrack();
    }
}

impl<T> StoreField for ArcField<T> {
    type Value = T;
    type Reader = StoreFieldReader<T>;
    type Writer = StoreFieldWriter<T>;

    fn get_trigger(&self, path: StorePath) -> StoreFieldTrigger {
        (self.get_trigger)(path)
    }

    fn path(&self) -> impl IntoIterator<Item = StorePathSegment> {
        (self.path)()
    }

    fn reader(&self) -> Option<Self::Reader> {
        (self.read)().map(StoreFieldReader::new)
    }

    fn writer(&self) -> Option<Self::Writer> {
        (self.write)().map(StoreFieldWriter::new)
    }

    fn keys(&self) -> Option<KeyMap> {
        (self.keys)()
    }
}

impl<T, S> From<Store<T, S>> for ArcField<T>
where
    T: 'static,
    S: Storage<ArcStore<T>>,
{
    #[track_caller]
    fn from(value: Store<T, S>) -> Self {
        ArcField {
            #[cfg(any(debug_assertions, leptos_debuginfo))]
            defined_at: Location::caller(),
            path: Arc::new(move || value.path().into_iter().collect()),
            get_trigger: Arc::new(move |path| value.get_trigger(path)),
            read: Arc::new(move || value.reader().map(StoreFieldReader::new)),
            write: Arc::new(move || value.writer().map(StoreFieldWriter::new)),
            keys: Arc::new(move || value.keys()),
            track_field: Arc::new(move || value.track_field()),
            notify: Arc::new(move || value.notify()),
        }
    }
}

impl<T> From<ArcStore<T>> for ArcField<T>
where
    T: Send + Sync + 'static,
{
    #[track_caller]
    fn from(value: ArcStore<T>) -> Self {
        ArcField {
            #[cfg(any(debug_assertions, leptos_debuginfo))]
            defined_at: Location::caller(),
            path: Arc::new({
                let value = value.clone();
                move || value.path().into_iter().collect()
            }),
            get_trigger: Arc::new({
                let value = value.clone();
                move |path| value.get_trigger(path)
            }),
            read: Arc::new({
                let value = value.clone();
                move || value.reader().map(StoreFieldReader::new)
            }),
            write: Arc::new({
                let value = value.clone();
                move || value.writer().map(StoreFieldWriter::new)
            }),
            keys: Arc::new({
                let value = value.clone();
                move || value.keys()
            }),
            track_field: Arc::new({
                let value = value.clone();
                move || value.track_field()
            }),
            notify: Arc::new({
                let value = value.clone();
                move || value.notify()
            }),
        }
    }
}

impl<Inner, Prev, T> From<Subfield<Inner, Prev, T>> for ArcField<T>
where
    T: Send + Sync,
    Subfield<Inner, Prev, T>: Clone,
    Inner: StoreField<Value = Prev> + Send + Sync + 'static,
    Prev: 'static,
{
    #[track_caller]
    fn from(value: Subfield<Inner, Prev, T>) -> Self {
        ArcField {
            #[cfg(any(debug_assertions, leptos_debuginfo))]
            defined_at: Location::caller(),
            path: Arc::new({
                let value = value.clone();
                move || value.path().into_iter().collect()
            }),
            get_trigger: Arc::new({
                let value = value.clone();
                move |path| value.get_trigger(path)
            }),
            read: Arc::new({
                let value = value.clone();
                move || value.reader().map(StoreFieldReader::new)
            }),
            write: Arc::new({
                let value = value.clone();
                move || value.writer().map(StoreFieldWriter::new)
            }),
            keys: Arc::new({
                let value = value.clone();
                move || value.keys()
            }),
            track_field: Arc::new({
                let value = value.clone();
                move || value.track_field()
            }),
            notify: Arc::new({
                let value = value.clone();
                move || value.notify()
            }),
        }
    }
}

impl<Inner, T> From<DerefedField<Inner>> for ArcField<T>
where
    Inner: Clone + StoreField + Send + Sync + 'static,
    Inner::Value: Deref<Target = T> + DerefMut,
    T: Sized + 'static,
{
    #[track_caller]
    fn from(value: DerefedField<Inner>) -> Self {
        ArcField {
            #[cfg(any(debug_assertions, leptos_debuginfo))]
            defined_at: Location::caller(),
            path: Arc::new({
                let value = value.clone();
                move || value.path().into_iter().collect()
            }),
            get_trigger: Arc::new({
                let value = value.clone();
                move |path| value.get_trigger(path)
            }),
            read: Arc::new({
                let value = value.clone();
                move || value.reader().map(StoreFieldReader::new)
            }),
            write: Arc::new({
                let value = value.clone();
                move || value.writer().map(StoreFieldWriter::new)
            }),
            keys: Arc::new({
                let value = value.clone();
                move || value.keys()
            }),
            track_field: Arc::new({
                let value = value.clone();
                move || value.track_field()
            }),
            notify: Arc::new({
                let value = value.clone();
                move || value.notify()
            }),
        }
    }
}

impl<Inner, Prev> From<AtIndex<Inner, Prev>> for ArcField<Prev::Output>
where
    AtIndex<Inner, Prev>: Clone,
    Inner: StoreField<Value = Prev> + Send + Sync + 'static,
    Prev: IndexMut<usize> + Send + Sync + 'static,
    Prev::Output: Sized + Send + Sync,
{
    #[track_caller]
    fn from(value: AtIndex<Inner, Prev>) -> Self {
        ArcField {
            #[cfg(any(debug_assertions, leptos_debuginfo))]
            defined_at: Location::caller(),
            path: Arc::new({
                let value = value.clone();
                move || value.path().into_iter().collect()
            }),
            get_trigger: Arc::new({
                let value = value.clone();
                move |path| value.get_trigger(path)
            }),
            read: Arc::new({
                let value = value.clone();
                move || value.reader().map(StoreFieldReader::new)
            }),
            write: Arc::new({
                let value = value.clone();
                move || value.writer().map(StoreFieldWriter::new)
            }),
            keys: Arc::new({
                let value = value.clone();
                move || value.keys()
            }),
            track_field: Arc::new({
                let value = value.clone();
                move || value.track_field()
            }),
            notify: Arc::new({
                let value = value.clone();
                move || value.notify()
            }),
        }
    }
}

impl<Inner, Prev, K, T> From<AtKeyed<Inner, Prev, K, T>> for ArcField<T::Output>
where
    AtKeyed<Inner, Prev, K, T>: Clone,
    K: Debug + Send + Sync + PartialEq + Eq + Hash + 'static,
    KeyedSubfield<Inner, Prev, K, T>: Clone,
    for<'a> &'a T: IntoIterator,
    Inner: StoreField<Value = Prev> + Send + Sync + 'static,
    Prev: 'static,
    T: IndexMut<usize> + 'static,
    T::Output: Sized,
{
    #[track_caller]
    fn from(value: AtKeyed<Inner, Prev, K, T>) -> Self {
        ArcField {
            #[cfg(any(debug_assertions, leptos_debuginfo))]
            defined_at: Location::caller(),
            path: Arc::new({
                let value = value.clone();
                move || value.path().into_iter().collect()
            }),
            get_trigger: Arc::new({
                let value = value.clone();
                move |path| value.get_trigger(path)
            }),
            read: Arc::new({
                let value = value.clone();
                move || value.reader().map(StoreFieldReader::new)
            }),
            write: Arc::new({
                let value = value.clone();
                move || value.writer().map(StoreFieldWriter::new)
            }),
            keys: Arc::new({
                let value = value.clone();
                move || value.keys()
            }),
            track_field: Arc::new({
                let value = value.clone();
                move || value.track_field()
            }),
            notify: Arc::new({
                let value = value.clone();
                move || value.notify()
            }),
        }
    }
}

impl<T> Clone for ArcField<T> {
    fn clone(&self) -> Self {
        Self {
            #[cfg(any(debug_assertions, leptos_debuginfo))]
            defined_at: self.defined_at,
            path: self.path.clone(),
            get_trigger: Arc::clone(&self.get_trigger),
            read: Arc::clone(&self.read),
            write: Arc::clone(&self.write),
            keys: Arc::clone(&self.keys),
            track_field: Arc::clone(&self.track_field),
            notify: Arc::clone(&self.notify),
        }
    }
}

impl<T> DefinedAt for ArcField<T> {
    fn defined_at(&self) -> Option<&'static Location<'static>> {
        #[cfg(any(debug_assertions, leptos_debuginfo))]
        {
            Some(self.defined_at)
        }
        #[cfg(not(any(debug_assertions, leptos_debuginfo)))]
        {
            None
        }
    }
}

impl<T> Notify for ArcField<T> {
    fn notify(&self) {
        (self.notify)()
    }
}

impl<T> Track for ArcField<T> {
    fn track(&self) {
        (self.track_field)();
    }
}

impl<T> ReadUntracked for ArcField<T> {
    type Value = StoreFieldReader<T>;

    fn try_read_untracked(&self) -> Option<Self::Value> {
        (self.read)()
    }
}

impl<T> Write for ArcField<T> {
    type Value = T;

    fn try_write(&self) -> Option<impl UntrackableGuard<Target = Self::Value>> {
        (self.write)()
    }

    fn try_write_untracked(
        &self,
    ) -> Option<impl DerefMut<Target = Self::Value>> {
        let mut guard = (self.write)()?;
        guard.untrack();
        Some(guard)
    }
}

impl<T> IsDisposed for ArcField<T> {
    fn is_disposed(&self) -> bool {
        false
    }
}