//! Utility module to safely refer to a mutable Arc.

use std::sync::{Arc, RwLock};

use educe::Educe;

use crate::{Error, Result};

/// A shareable mutable-ish optional reference to a an [`Arc`].

///

/// Because you can't actually change a shared [`Arc`], this type implements

/// mutability by replacing the Arc itself with a new value.  It tries

/// to avoid needless clones by taking advantage of [`Arc::make_mut`].

///

// We give this construction its own type to simplify its users, and make

// sure we don't hold the lock against any async suspend points.

#[educe(Default)]

#[cfg_attr(docsrs, doc(cfg(feature = "experimental-api")))]

#[cfg_attr(not(feature = "experimental-api"), allow(unreachable_pub))]

pub struct SharedMutArc<T> {

    /// Locked reference to the current value.

    ///

    /// (It's okay to use RwLock here, because we never suspend

    /// while holding the lock.)

    dir: RwLock<Option<Arc<T>>>,

}

#[cfg_attr(not(feature = "experimental-api"), allow(unreachable_pub))]

impl<T> SharedMutArc<T> {

    /// Construct a new empty SharedMutArc.

    /// Replace the current value with `new_val`.

    /// Remove the current value of this SharedMutArc.

    #[allow(unused)]

    /// Return a new reference to the current value, if there is one.

    /// Replace the contents of this SharedMutArc with the results of applying

    /// `func` to the inner value.

    ///

    /// Gives an error if there is no inner value.

    ///

    /// Other threads will not abe able to access the inner value

    /// while the function is running.

    ///

    /// # Limitation: No panic-safety

    ///

    /// If `func` panics while it's running, this object will become invalid

    /// and future attempts to use it will panic. (TODO: Fix this.)

    // Note: If we decide to make this type public, we'll probably

    // want to fiddle with how we handle the return type.

        }

}

#[cfg(test)]

mod test {

    // @@ begin test lint list maintained by maint/add_warning @@

    #![allow(clippy::bool_assert_comparison)]

    #![allow(clippy::clone_on_copy)]

    #![allow(clippy::dbg_macro)]

    #![allow(clippy::mixed_attributes_style)]

    #![allow(clippy::print_stderr)]

    #![allow(clippy::print_stdout)]

    #![allow(clippy::single_char_pattern)]

    #![allow(clippy::unwrap_used)]

    #![allow(clippy::unchecked_duration_subtraction)]

    #![allow(clippy::useless_vec)]

    #![allow(clippy::needless_pass_by_value)]

    //! <!-- @@ end test lint list maintained by maint/add_warning @@ -->

    use super::*;

    #[test]

    fn shared_mut_arc() {

        let val: SharedMutArc<Vec<u32>> = SharedMutArc::new();

        assert_eq!(val.get(), None);

        val.replace(Vec::new());

        assert_eq!(val.get().unwrap().as_ref()[..], Vec::<u32>::new());

        val.mutate(|v| {

            v.push(99);

            Ok(())

        })

        .unwrap();

        assert_eq!(val.get().unwrap().as_ref()[..], [99]);

        val.clear();

        assert_eq!(val.get(), None);

        assert!(val

            .mutate(|v| {

                v.push(99);

                Ok(())

            })

            .is_err());

    }

}