about summary refs log tree commit diff
diff options
context:
space:
mode:
authordavid-perez <d@vidp.dev>2022-01-10 23:18:34 +0100
committerdavid-perez <d@vidp.dev>2022-01-10 23:18:34 +0100
commit5786bbddc670597af286381b27fbb9f563cf7dc7 (patch)
tree640b0b4e5b077c9ee49d529d28bb90db0eb2aaca
parent89b9f7b284aacc5f8613438b80e4dd7bdd10549e (diff)
downloadrust-5786bbddc670597af286381b27fbb9f563cf7dc7.tar.gz
rust-5786bbddc670597af286381b27fbb9f563cf7dc7.zip
Eliminate "boxed" wording in `std::error::Error` documentation
In commit 29403ee, documentation for the methods on `std::any::Any` was
modified so that they referred to the concrete value behind the trait
object as the "inner" value. This is a more accurate wording than
"boxed": while putting trait objects inside boxes is arguably the most
common use, they can also be placed behind other pointer types like
`&mut` or `std::sync::Arc`.

This commit does the same documentation changes for `std::error::Error`.
-rw-r--r--library/std/src/error.rs12
1 files changed, 6 insertions, 6 deletions
diff --git a/library/std/src/error.rs b/library/std/src/error.rs
index ea0c230fa42..526a1b92b19 100644
--- a/library/std/src/error.rs
+++ b/library/std/src/error.rs
@@ -606,21 +606,21 @@ impl Error for time::FromSecsError {}
 
 // Copied from `any.rs`.
 impl dyn Error + 'static {
-    /// Returns `true` if the boxed type is the same as `T`
+    /// Returns `true` if the inner type is the same as `T`.
     #[stable(feature = "error_downcast", since = "1.3.0")]
     #[inline]
     pub fn is<T: Error + 'static>(&self) -> bool {
         // Get `TypeId` of the type this function is instantiated with.
         let t = TypeId::of::<T>();
 
-        // Get `TypeId` of the type in the trait object.
-        let boxed = self.type_id(private::Internal);
+        // Get `TypeId` of the type in the trait object (`self`).
+        let concrete = self.type_id(private::Internal);
 
         // Compare both `TypeId`s on equality.
-        t == boxed
+        t == concrete
     }
 
-    /// Returns some reference to the boxed value if it is of type `T`, or
+    /// Returns some reference to the inner value if it is of type `T`, or
     /// `None` if it isn't.
     #[stable(feature = "error_downcast", since = "1.3.0")]
     #[inline]
@@ -632,7 +632,7 @@ impl dyn Error + 'static {
         }
     }
 
-    /// Returns some mutable reference to the boxed value if it is of type `T`, or
+    /// Returns some mutable reference to the inner value if it is of type `T`, or
     /// `None` if it isn't.
     #[stable(feature = "error_downcast", since = "1.3.0")]
     #[inline]