Add as_ref and check to Refinement, fix docs.

Author: nekitdev

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "refinement-types"
-version = "0.0.0"
+version = "0.1.0"
 authors = ["nekitdev <[email protected]>"]
 edition = "2024"
 description = "Refinement types."

README.md

@@ -21,7 +21,7 @@ Or by directly specifying it in the configuration like so:
 
 ```toml
 [dependencies]
-refinement-types = "0.0.0"
+refinement-types = "0.1.0"
 ```
 
 Alternatively, you can add it directly from the source:

changelogging.toml

@@ -1,6 +1,6 @@
 [context]
 name = "refinement-types"
-version = "0.0.0"
+version = "0.1.0"
 url = "https://github.com/nekitdev/refinement-types"
 
 [formats]

changes/~as-ref.feature.md

@@ -0,0 +1 @@
+Added `AsRef<T>` for `Refinement<T, P, C>`.

changes/~check.feature.md

@@ -0,0 +1 @@
+Added `check` for `Refinement<T, P, C>` that calls `P::check` and returns `Result<(), P::Error>`.

src/core.rs

@@ -145,6 +145,12 @@ impl<T: Hash, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> Hash for Refinement
     }
 }
 
+impl<T, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> AsRef<T> for Refinement<T, P, C> {
+    fn as_ref(&self) -> &T {
+        self.get()
+    }
+}
+
 impl<T, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> Deref for Refinement<T, P, C> {
     type Target = T;
 
@@ -350,13 +356,22 @@ impl<T, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> Refinement<T, P, C> {
     ///
     /// Returns [`struct@Error`] if the value does not satisfy the predicate.
     pub fn refine(value: T) -> Result<Self, Error<T, P, C>> {
-        match P::check(&value) {
+        match Self::check(&value) {
             // SAFETY: the value satisfies the predicate if the check is successful
             Ok(()) => Ok(unsafe { Self::unchecked(value) }),
             Err(error) => Err(Error::new(value, error)),
         }
     }
 
+    /// Checks the given value.
+    ///
+    /// # Errors
+    ///
+    /// Returns the error produced by the predicate if the value does not satisfy it.
+    pub fn check(value: &T) -> Result<(), P::Error> {
+        P::check(value)
+    }
+
     /// Maps the value of the refinement.
     ///
     /// # Errors

src/lib.rs

@@ -10,7 +10,7 @@
 
 #![cfg_attr(not(feature = "std"), no_std)]
 #![deny(missing_docs)]
-#![cfg_attr(docsrs, feature(auto_doc_cfg))]
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 
 #[cfg(feature = "alloc")]
 extern crate alloc;