Add lint rules and fix lint errors

benches/src/lib.rs

@@ -1,4 +1,11 @@
 #![cfg(feature = "comparison")]
+#![deny(
+    missing_debug_implementations,
+    rust_2018_idioms,
+    unreachable_pub,
+    elided_lifetimes_in_paths,
+    clippy::missing_const_for_fn
+)]
 
 pub mod async_std;
 pub mod mutex;

latches/src/futex/mod.rs

@@ -207,8 +207,12 @@ impl Latch {
         self.stat.load(Acquire)
     }
 
-    /// Checks that the current counter has reached 0 and return [`Ok(())`],
-    /// otherwise return [`Err(count)`].
+    /// Checks that the current counter has reached 0.
+    ///
+    /// # Errors
+    ///
+    /// This function will return an error with the current count if the
+    /// counter has not reached 0.
     ///
     /// # Examples
     ///

latches/src/lib.rs

@@ -3,7 +3,11 @@
     missing_docs,
     rust_2018_idioms,
     unreachable_pub,
-    elided_lifetimes_in_paths
+    elided_lifetimes_in_paths,
+    clippy::missing_const_for_fn,
+    clippy::missing_panics_doc,
+    clippy::missing_safety_doc,
+    clippy::missing_errors_doc
 )]
 #![doc(test(no_crate_inject, attr(deny(warnings, rust_2018_idioms))))]
 #![cfg_attr(docsrs, feature(doc_cfg))]

latches/src/sync/mod.rs

@@ -210,8 +210,12 @@ impl Latch {
         self.stat.load(Acquire)
     }
 
-    /// Checks that the current counter has reached 0 and return [`Ok(())`],
-    /// otherwise return [`Err(count)`].
+    /// Checks that the current counter has reached 0.
+    ///
+    /// # Errors
+    ///
+    /// This function will return an error with the current count if the
+    /// counter has not reached 0.
     ///
     /// # Examples
     ///

latches/src/task/mod.rs

@@ -214,8 +214,12 @@ impl Latch {
         self.stat.load(Acquire)
     }
 
-    /// Checks that the counter has reached 0 and return [`Ok(())`], otherwise
-    /// return [`Err(count)`].
+    /// Checks that the counter has reached 0.
+    ///
+    /// # Errors
+    ///
+    /// This function will return an error with the current count if the
+    /// counter has not reached 0.
     ///
     /// # Examples
     ///
@@ -262,7 +266,7 @@ impl Latch {
     /// # });
     /// ```
     #[inline]
-    pub fn wait(&self) -> LatchWait<'_> {
+    pub const fn wait(&self) -> LatchWait<'_> {
         LatchWait {
             id: None,
             latch: self,
@@ -341,7 +345,7 @@ impl Latch {
     /// # });
     /// ```
     #[inline]
-    pub fn watch<T>(&self, timer: T) -> LatchWatch<'_, T> {
+    pub const fn watch<T>(&self, timer: T) -> LatchWatch<'_, T> {
         LatchWatch {
             id: None,
             latch: self,

latches/src/task/tests.rs

@@ -277,7 +277,7 @@ unsafe fn v_c(ptr: *const ()) -> RawWaker {
 unsafe fn wake(ptr: *const ()) {
     (*(ptr as *const AtomicU32)).fetch_add(1, Ordering::Relaxed);
 }
-unsafe fn noop(_: *const ()) {}
+const unsafe fn noop(_: *const ()) {}
 
 fn new_waker(data: Pin<&AtomicU32>) -> Waker {
     unsafe {

latches/src/task/waiters/tests.rs

@@ -27,7 +27,7 @@ unsafe fn v_c(ptr: *const ()) -> RawWaker {
 unsafe fn wake(ptr: *const ()) {
     (*(ptr as *const AtomicU32)).fetch_add(1, Ordering::Relaxed);
 }
-unsafe fn noop(_: *const ()) {}
+const unsafe fn noop(_: *const ()) {}
 
 fn new_waker(data: Pin<&AtomicU32>) -> Waker {
     unsafe {

latches/src/timeout/mod.rs

@@ -30,7 +30,7 @@ impl<T> WaitTimeoutResult<T> {
     /// ```
     #[must_use]
     #[inline]
-    pub fn is_reached(&self) -> bool {
+    pub const fn is_reached(&self) -> bool {
         matches!(self, WaitTimeoutResult::Reached)
     }
 
@@ -49,7 +49,7 @@ impl<T> WaitTimeoutResult<T> {
     /// ```
     #[must_use]
     #[inline]
-    pub fn is_timed_out(&self) -> bool {
+    pub const fn is_timed_out(&self) -> bool {
         matches!(self, WaitTimeoutResult::TimedOut(_))
     }
 
@@ -87,6 +87,11 @@ impl<T> WaitTimeoutResult<T> {
     /// result of a function call, it is recommended to use [`ok_by`], which
     /// is lazily evaluated.
     ///
+    /// # Errors
+    ///
+    /// This function will return an error with the content of [`TimedOut(t)`]
+    /// if it is timed out.
+    ///
     /// [`Ok(v)`]: Ok
     /// [`Err(t)`]: Err
     /// [`Reached`]: WaitTimeoutResult::Reached
@@ -120,6 +125,11 @@ impl<T> WaitTimeoutResult<T> {
     /// [`Reached`]: WaitTimeoutResult::Reached
     /// [`TimedOut(t)`]: WaitTimeoutResult::TimedOut
     ///
+    /// # Errors
+    ///
+    /// This function will return an error with the content of [`TimedOut(t)`]
+    /// if it is timed out.
+    ///
     /// # Examples
     ///
     /// ```

latches/src/timeout/tests.rs

@@ -26,7 +26,7 @@ fn test_ok() {
 
 #[test]
 fn test_ok_by() {
-    fn lazy_one() -> i32 {
+    const fn lazy_one() -> i32 {
         1
     }