Merge pull request #335 from Freax13/cr2-read-returns-result

make `Cr2::read` return a result

Author: phil-opp

src/registers/control.rs

@@ -160,7 +160,10 @@ bitflags! {
 #[cfg(feature = "instructions")]
 mod x86_64 {
     use super::*;
-    use crate::{instructions::tlb::Pcid, structures::paging::PhysFrame, PhysAddr, VirtAddr};
+    use crate::{
+        addr::VirtAddrNotValid, instructions::tlb::Pcid, structures::paging::PhysFrame, PhysAddr,
+        VirtAddr,
+    };
     #[cfg(feature = "inline_asm")]
     use core::arch::asm;
 
@@ -251,9 +254,14 @@ mod x86_64 {
 
     impl Cr2 {
         /// Read the current page fault linear address from the CR2 register.
+        ///
+        /// # Errors
+        ///
+        /// This method returns a [`VirtAddrNotValid`] error if the CR2 register contains a
+        /// non-canonical address. Call [`Cr2::read_raw`] to handle such cases.
         #[inline]
-        pub fn read() -> VirtAddr {
-            VirtAddr::new(Self::read_raw())
+        pub fn read() -> Result<VirtAddr, VirtAddrNotValid> {
+            VirtAddr::try_new(Self::read_raw())
         }
 
         /// Read the current page fault linear address from the CR2 register as a raw `u64`.