Add VolatileRef::restrict and VolatilePtr::restrict

Signed-off-by: Martin Kröning <[email protected]>

Author: mkroening

src/volatile_ptr/operations.rs

@@ -219,6 +219,29 @@ impl<'a, T> VolatilePtr<'a, T, ReadWrite>
 where
     T: ?Sized,
 {
+    /// Restricts access permissions to `A`.
+    ///
+    /// ## Example
+    ///
+    /// ```
+    /// use volatile::access::ReadOnly;
+    /// use volatile::VolatilePtr;
+    /// use core::ptr::NonNull;
+    ///
+    /// let mut value: i16 = -4;
+    /// let mut volatile = unsafe { VolatilePtr::new((&mut value).into()) };
+    ///
+    /// let read_only = volatile.restrict::<ReadOnly>();
+    /// assert_eq!(read_only.read(), -4);
+    /// // read_only.write(10); // compile-time error
+    /// ```
+    pub fn restrict<A>(self) -> VolatilePtr<'a, T, A>
+    where
+        A: Access,
+    {
+        unsafe { VolatilePtr::new_restricted(Default::default(), self.pointer) }
+    }
+
     /// Restricts access permissions to read-only.
     ///
     /// ## Example
@@ -235,7 +258,7 @@ where
     /// // read_only.write(10); // compile-time error
     /// ```
     pub fn read_only(self) -> VolatilePtr<'a, T, ReadOnly> {
-        unsafe { VolatilePtr::new_restricted(ReadOnly, self.pointer) }
+        self.restrict()
     }
 
     /// Restricts access permissions to write-only.
@@ -258,6 +281,6 @@ where
     /// // field_2.read(); // compile-time error
     /// ```
     pub fn write_only(self) -> VolatilePtr<'a, T, WriteOnly> {
-        unsafe { VolatilePtr::new_restricted(WriteOnly, self.pointer) }
+        self.restrict()
     }
 }

src/volatile_ref.rs

@@ -174,6 +174,29 @@ impl<'a, T> VolatileRef<'a, T, ReadWrite>
 where
     T: ?Sized,
 {
+    /// Restricts access permissions to `A`.
+    /// 
+    /// ## Example
+    ///
+    /// ```
+    /// use volatile::access::ReadOnly;
+    /// use volatile::VolatileRef;
+    /// use core::ptr::NonNull;
+    ///
+    /// let mut value: i16 = -4;
+    /// let mut volatile = VolatileRef::from_mut_ref(&mut value);
+    ///
+    /// let read_only = volatile.restrict::<ReadOnly>();
+    /// assert_eq!(read_only.as_ptr().read(), -4);
+    /// // read_only.as_ptr().write(10); // compile-time error
+    /// ```
+    pub fn restrict<A>(self) -> VolatileRef<'a, T, A>
+    where
+        A: Access,
+    {
+        unsafe { VolatileRef::new_restricted(Default::default(), self.pointer) }
+    }
+
     /// Restricts access permissions to read-only.
     ///
     /// ## Example
@@ -190,7 +213,7 @@ where
     /// // read_only.as_ptr().write(10); // compile-time error
     /// ```
     pub fn read_only(self) -> VolatileRef<'a, T, ReadOnly> {
-        unsafe { VolatileRef::new_restricted(ReadOnly, self.pointer) }
+        self.restrict()
     }
 
     /// Restricts access permissions to write-only.
@@ -212,7 +235,7 @@ where
     /// // write_only.as_ptr().read(); // compile-time error
     /// ```
     pub fn write_only(self) -> VolatileRef<'a, T, WriteOnly> {
-        unsafe { VolatileRef::new_restricted(WriteOnly, self.pointer) }
+        self.restrict()
     }
 }