improvements for naming and docs

Author: robamu

embedded-can/CHANGELOG.md

@@ -12,7 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
-- `as_raw` getter function for `Id`
+- `as_raw_unchecked` getter function for `Id`
 
 ## [v0.4.1] - 2022-09-28
 

embedded-can/src/id.rs

@@ -105,9 +105,16 @@ pub enum Id {
 }
 
 impl Id {
-    /// Returns the CAN Identifier as a raw 32-bit integer.
+    /// Returns the CAN Identifier as a raw 32-bit integer, ignoring the distinction between
+    /// standard ID and extended ID.
+    ///
+    /// This function ignores that a standard ID and an extended ID are different IDs, even
+    /// if their numerical values are the same. It should only be used if the raw numerical value
+    /// is required and the distinction between standard ID and extended ID is irrelevant.
+    ///
+    /// In all other cases, it is recommended to de-structure the ID with a match statement.
     #[inline]
-    pub fn as_raw(&self) -> u32 {
+    pub fn as_raw_unchecked(&self) -> u32 {
         match self {
             Id::Standard(id) => id.as_raw() as u32,
             Id::Extended(id) => id.as_raw(),