sugars 3.0.1

//! A module related to the Rust standard smart pointer

/// Create a new [`Box`].
///
/// It is also able to create tuples if given more than one parameter.
///
/// # Example
/// ```
/// use sugars::boxed;
/// # fn main() {
/// assert_eq!(Box::new(10), boxed!(10));
///
/// // Tuple example
/// let (box_a, box_b) = boxed!(10, "my_str");
/// assert_eq!(Box::new(10), box_a);
/// assert_eq!(Box::new("my_str"), box_b);
/// # }
/// ```
#[macro_export]
macro_rules! boxed {
    ($e:expr) => {
        ::std::boxed::Box::new($e)
    };
    ($e:expr,) => {
        $crate::boxed!($e)
    };
    ($($e:expr),+ $(,)?) => {
        ($($crate::boxed!($e)),+,)
    };
}

/// Create a new [`Rc`].
///
/// It is also able to create tuples if given more than one parameter.
///
/// # Example
/// ```
/// use std::rc::Rc;
/// use sugars::rc;
/// # fn main() {
/// assert_eq!(Rc::new(10), rc!(10));
/// # }
/// ```
///
/// [`Rc`]: ::std::rc::Rc
#[macro_export]
macro_rules! rc {
    ($e:expr) => {
        ::std::rc::Rc::new($e)
    };
    ($e:expr,) => {
        $crate::rc!($e)
    };
    ($($e:expr),+ $(,)?) => {
        ($($crate::rc!($e)),+,)
    };
}

/// Create new [`Cow`] type.
///
/// It has 3 ways to use: auto, borrowed and owned.
///
/// - Auto: Uses the [`Cow::from`] in the passed expression
/// - Borrowed: Uses [`Cow::Borrowed`] in the passed expression
/// - Owned: Uses [`Cow::Owned`] in the passed expression
///
/// # Examples
///
/// ```
/// use std::borrow::Cow;
/// use sugars::cow;
///
/// let s = String::from("Hello");
///
/// let auto = cow!(&s);
/// let borrowed = cow!(borrow s);
/// let owned: Cow<'_, String> = cow!(own String::from("Owned"));
/// ```
///
/// ```
/// use std::borrow::Cow;
/// use sugars::cow;
///
/// let s = String::from("Help");
/// let expected: Cow<_> = Cow::Borrowed(&s);
/// let test: Cow<_> = cow!(&s);
///
/// assert_eq!(expected, test);
/// ```
///
/// [`Cow`]: ::std::borrow::Cow
/// [`Cow::from`]: ::std::borrow::Cow::from
/// [`Cow::Borrowed`]: ::std::borrow::Cow::Borrowed
/// [`Cow::Owned`]: ::std::borrow::Cow::Owned
#[macro_export]
macro_rules! cow {
    ($e:expr) => {
        ::std::borrow::Cow::from($e)
    };
    (borrow $e:ident) => {
        ::std::borrow::Cow::Borrowed(&$e)
    };
    (own $e:expr) => {
        ::std::borrow::Cow::Owned($e)
    };
}

/// Create a new [`Cell`].
///
/// It is also able to create tuples if given more than one parameter.
///
/// # Example
/// ```
/// use std::cell::Cell;
/// use sugars::cell;
///
/// assert_eq!(Cell::new(10), cell!(10));
/// ```
///
/// [`Cell`]: ::std::cell::Cell
#[macro_export]
macro_rules! cell {
    ($e:expr) => {
        ::std::cell::Cell::new($e)
    };
    ($e:expr,) => {
        $crate::cell!($e)
    };
    ($($e:expr),+ $(,)?) => {
        ($($crate::cell!($e)),+,)
    };
}

/// Create a new [`RefCell`].
///
/// It is also able to create tuples if given more than one parameter.
///
/// # Example
/// ```
/// use std::cell::RefCell;
/// use sugars::refcell;
/// # fn main() {
/// assert_eq!(RefCell::new(10), refcell!(10));
/// # }
/// ```
///
/// [`RefCell`]: ::std::cell::RefCell
#[macro_export]
macro_rules! refcell {
    ($e:expr) => {
        ::std::cell::RefCell::new($e)
    };
    ($e:expr,) => {
        $crate::refcell!($e)
    };
    ($($e:expr),+ $(,)?) => {
        ($($crate::refcell!($e)),+,)
    };
}

/// Create a new [`Arc`].
///
/// It is also able to create tuples if given more than one parameter.
///
/// # Example
/// ```
/// use std::sync::Arc;
/// use sugars::arc;
/// # fn main() {
/// assert_eq!(Arc::new(10), arc!(10));
/// # }
/// ```
///
/// [`Arc`]: ::std::sync::Arc
#[macro_export]
macro_rules! arc {
    ($e:expr) => {
        ::std::sync::Arc::new($e)
    };
    ($e:expr,) => {
        $crate::arc!($e)
    };
    ($($e:expr),+ $(,)?) => {
        ($($crate::arc!($e)),+,)
    };
}

/// Create a new [`Mutex`].
///
/// It is also able to create tuples if given more than one parameter.
///
/// # Example
/// ```
/// use std::sync::Mutex;
/// use sugars::mutex;
/// # fn main() {
/// let mutex = mutex!(String::new());
/// let mut locked = mutex.lock().unwrap();
/// (*locked).push_str("Hello World");
/// # }
/// ```
///
/// [`Mutex`]: ::std::sync::Mutex
#[macro_export]
macro_rules! mutex {
    ($e:expr) => {
        ::std::sync::Mutex::new($e)
    };
    ($e:expr,) => {
        $crate::mutex!($e)
    };
    ($($e:expr),+ $(,)?) => {
        ($($crate::mutex!($e)),+,)
    };
}

/// Create a new [`RwLock`].
///
/// It is also able to create tuples if given more than one parameter.
///
/// # Example
/// ```
/// use std::sync::RwLock;
/// use sugars::rwlock;
/// # fn main() {
/// let rwlk = rwlock!(String::new());
/// let mut read = rwlk.read().unwrap();
/// println!("{}", read);
/// # }
/// ```
///
/// [`RwLock`]: ::std::sync::RwLock
#[macro_export]
macro_rules! rwlock {
    ($e:expr) => {
        ::std::sync::RwLock::new($e)
    };
    ($e:expr,) => {
        $crate::mutex!($e)
    };
    ($($e:expr),+ $(,)?) => {
        ($($crate::mutex!($e)),+,)
    };
}

#[cfg(test)]
mod tests {

    #[test]
    fn boxed() {
        assert_eq!(Box::new(10), boxed!(10));
        assert_eq!(Box::new(Some("String")), boxed!(Some("String")));
    }

    #[test]
    fn boxed_trailing_comma() {
        assert_eq!(Box::new(10), boxed!(10,));
        assert_eq!(Box::new(Some("String")), boxed!(Some("String"),));
    }

    #[test]
    fn boxed_tuples() {
        let expected1 = (Box::new(10), Box::new(11));
        let expected2 = (Box::new(Some("String")), Box::new(Some("other_str")));
        assert_eq!(expected1, boxed!(10, 11));
        assert_eq!(expected2, boxed!(Some("String"), Some("other_str")));
    }

    #[test]
    fn rc() {
        use std::rc::Rc;
        assert_eq!(Rc::new(10), rc!(10));
        assert_eq!(Rc::new(Some("String")), rc!(Some("String")));
    }

    #[test]
    fn rc_trailing_comma() {
        use std::rc::Rc;
        assert_eq!(Rc::new(10), rc!(10,));
        assert_eq!(Rc::new(Some("String")), rc!(Some("String"),));
    }

    #[test]
    fn rc_tuples() {
        use std::rc::Rc;
        let expected1 = (Rc::new(10), Rc::new(11));
        let expected2 = (Rc::new(Some("String")), Rc::new(Some("other_str")));
        assert_eq!(expected1, rc!(10, 11));
        assert_eq!(expected2, rc!(Some("String"), Some("other_str")));
    }

    #[test]
    fn cow() {
        use std::borrow::Cow;

        #[derive(Clone, PartialEq, Debug)]
        struct Test(i32);

        let test1 = String::from("Hello Cow");
        let expected: Cow<str> = Cow::Borrowed(&test1);
        let test: Cow<str> = cow!(&test1);

        assert_eq!(expected, test);

        let test2 = Test(10);
        let expected: Cow<Test> = Cow::Borrowed(&test2);
        let test = cow!(borrow test2);
        assert_eq!(expected, test);

        let expected: Cow<str> = Cow::Owned(String::from("Hello Cow"));
        let test: Cow<str> = cow!(own String::from("Hello Cow"));

        assert_eq!(expected, test);

        let expected: Cow<Test> = Cow::Owned(Test(10));
        let test = cow!(own Test(10));
        assert_eq!(expected, test);
    }

    #[test]
    fn cell() {
        use std::cell::Cell;
        assert_eq!(Cell::new(10), cell!(10));
        assert_eq!(Cell::new(Some("String")), cell!(Some("String")));
    }

    #[test]
    fn cell_trailing_comma() {
        use std::cell::Cell;
        assert_eq!(Cell::new(10), cell!(10,));
        assert_eq!(Cell::new(Some("String")), cell!(Some("String"),));
    }

    #[test]
    fn cell_tuples() {
        use std::cell::Cell;
        let expected1 = (Cell::new(10), Cell::new(11));
        let expected2 = (Cell::new(Some("String")), Cell::new(Some("other_str")));
        assert_eq!(expected1, cell!(10, 11));
        assert_eq!(expected2, cell!(Some("String"), Some("other_str")));
    }

    #[test]
    fn refcell() {
        use std::cell::RefCell;
        assert_eq!(RefCell::new(10), refcell!(10));
        assert_eq!(RefCell::new(Some("String")), refcell!(Some("String")));
    }

    #[test]
    fn refcell_trailing_comma() {
        use std::cell::RefCell;
        assert_eq!(RefCell::new(10), refcell!(10,));
        assert_eq!(RefCell::new(Some("String")), refcell!(Some("String"),));
    }

    #[test]
    fn refcell_tuples() {
        use std::cell::RefCell;
        let expected1 = (RefCell::new(10), RefCell::new(11));
        let expected2 = (
            RefCell::new(Some("String")),
            RefCell::new(Some("other_str")),
        );
        assert_eq!(expected1, refcell!(10, 11));
        assert_eq!(expected2, refcell!(Some("String"), Some("other_str")));
    }

    #[test]
    fn arc() {
        use std::sync::Arc;
        assert_eq!(Arc::new(10), arc!(10));
        assert_eq!(Arc::new(Some("String")), arc!(Some("String")));
    }

    #[test]
    fn arc_trailing_comma() {
        use std::sync::Arc;
        assert_eq!(Arc::new(10), arc!(10,));
        assert_eq!(Arc::new(Some("String")), arc!(Some("String"),));
    }

    #[test]
    fn arc_tuples() {
        use std::sync::Arc;
        let expected1 = (Arc::new(10), Arc::new(11));
        let expected2 = (Arc::new(Some("String")), Arc::new(Some("other_str")));
        assert_eq!(expected1, arc!(10, 11));
        assert_eq!(expected2, arc!(Some("String"), Some("other_str")));
    }

    #[test]
    fn mutex() {
        use std::sync::Mutex;

        let mutex_expected = Mutex::new(Some("String"));
        let mutex_test = mutex!(Some("String"));

        let expected = mutex_expected.lock().unwrap();
        let test = mutex_test.lock().unwrap();
        assert_eq!(expected.is_some(), test.is_some());
    }

    #[test]
    fn rwlock() {
        use std::sync::RwLock;

        let rwlk_expected = RwLock::new(Some("String"));
        let rwlk_test = rwlock!(Some("String"));

        let expected = rwlk_expected.read().unwrap();
        let test = rwlk_test.read().unwrap();
        assert_eq!(expected.is_some(), test.is_some());
    }
}