Rollup merge of #92748 - david-perez:eliminate-boxed-wording-std-error, r=Mark-Simulacrum

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`.
This commit is contained in:
Matthias Krüger 2022-01-12 07:12:15 +01:00 committed by GitHub
commit 286bb18a9b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -606,21 +606,21 @@ impl Error for time::FromSecsError {}
// Copied from `any.rs`. // Copied from `any.rs`.
impl dyn Error + 'static { 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")] #[stable(feature = "error_downcast", since = "1.3.0")]
#[inline] #[inline]
pub fn is<T: Error + 'static>(&self) -> bool { pub fn is<T: Error + 'static>(&self) -> bool {
// Get `TypeId` of the type this function is instantiated with. // Get `TypeId` of the type this function is instantiated with.
let t = TypeId::of::<T>(); let t = TypeId::of::<T>();
// Get `TypeId` of the type in the trait object. // Get `TypeId` of the type in the trait object (`self`).
let boxed = self.type_id(private::Internal); let concrete = self.type_id(private::Internal);
// Compare both `TypeId`s on equality. // 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. /// `None` if it isn't.
#[stable(feature = "error_downcast", since = "1.3.0")] #[stable(feature = "error_downcast", since = "1.3.0")]
#[inline] #[inline]
@ -632,7 +632,7 @@ pub fn downcast_ref<T: Error + 'static>(&self) -> Option<&T> {
} }
} }
/// 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. /// `None` if it isn't.
#[stable(feature = "error_downcast", since = "1.3.0")] #[stable(feature = "error_downcast", since = "1.3.0")]
#[inline] #[inline]