Add rwlock macro

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changes
 
 ## Unreleased ~ master ~ 2.0-dev
+ - Add `rwlock!` macro to create `RwLock` types
  - Remove haskell-like and python-like comprehension syntax
  - Re-implement comprehensions based on the `c!` macro
  - Add a comprehension macro for lazy iterators: `c!`

Cargo.toml

@@ -14,7 +14,6 @@ exclude = ["/.travis.yml", "/.github"]
 edition = "2018"
 
 [badges]
-travis-ci = { repository = "GrayJack/sugars" }
 maintenance = { status = "actively-developed" }
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

README.md

@@ -36,6 +36,7 @@ on Rust ecosystem.
     * **mutex**: A simple macro to make a new `Mutex` value.²
     * **refcell**: A simple macro to make a new `RefCell` value.²
     * **rc**: A simple macro to make a new `Rc` value.²
+    * **rwlock**: A simple macro to make a new [`RwLock`] value.²
  * **Time/Duration:**
     * **dur**: Creates a `Duration` object following a time pattern¹
     * **sleep**: Makes a thread sleep a amount following a time pattern¹

src/lib.rs

@@ -28,6 +28,7 @@
 //!     * **mutex**: A simple macro to make a new [`Mutex`] value.²
 //!     * **refcell**: A simple macro to make a new [`RefCell`] value.²
 //!     * **rc**: A simple macro to make a new [`Rc`] value.²
+//!     * **rwlock**: A simple macro to make a new [`RwLock`] value.²
 //!  * **Time/Duration:**
 //!     * **dur**: Creates a [`Duration`] object following a time pattern¹
 //!     * **sleep**: Makes a thread sleep a amount following a time pattern¹
@@ -133,6 +134,7 @@
 //! [`Mutex`]: https://doc.rust-lang.org/std/sync/struct.Mutex.html
 //! [`Rc`]: https://doc.rust-lang.org/std/rc/struct.Rc.html
 //! [`RefCell`]: https://doc.rust-lang.org/std/cell/struct.RefCell.html
+//! [`RwLock`]: https://doc.rust-lang.org/std/sync/struct.RwLock.html
 //!
 //! [`Duration`]: https://doc.rust-lang.org/std/time/struct.Duration.html
 

src/pointer.rs

@@ -186,6 +186,35 @@ macro_rules! mutex {
     };
 }
 
+/// A simple macro to make a new [`RwLock`] value.
+///
+/// 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`]: https://doc.rust-lang.org/std/sync/struct.RwLock.html
+#[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 {
 
@@ -319,7 +348,7 @@ mod tests {
     }
 
     #[test]
-    fn mutex() -> Result<(), Box<dyn std::error::Error>> {
+    fn mutex() {
         use std::sync::Mutex;
 
         let mutex_expected = Mutex::new(Some("String"));
@@ -328,7 +357,17 @@ mod tests {
         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"));
 
-        Ok(())
+        let expected = rwlk_expected.read().unwrap();
+        let test = rwlk_test.read().unwrap();
+        assert_eq!(expected.is_some(), test.is_some());
     }
 }