mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #108964 - majaha:ptr_metadata_doc, r=workingjubilee

Browse Source 
Fix the docs for pointer method with_metadata_of

The name of the argument to `{*const T, *mut T}::with_metadata_of` was changed from `val` to `meta` recently, but the docs weren't updated to match.

Relevant pull request: #103701
This commit is contained in:
Matthias Krüger 2023-03-10 12:32:02 +01:00 committed by GitHub
commit df74b70b9e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
library/core/src/ptr/const_ptr.rs
View File

@ -61,14 +61,14 @@ impl<T: ?Sized> *const T {
/// Use the pointer value in a new pointer of another type. /// Use the pointer value in a new pointer of another type.
/// ///
/// In case `val` is a (fat) pointer to an unsized type, this operation /// In case `meta` is a (fat) pointer to an unsized type, this operation
/// will ignore the pointer part, whereas for (thin) pointers to sized /// will ignore the pointer part, whereas for (thin) pointers to sized
/// types, this has the same effect as a simple cast. /// types, this has the same effect as a simple cast.
/// ///
/// The resulting pointer will have provenance of `self`, i.e., for a fat /// The resulting pointer will have provenance of `self`, i.e., for a fat
/// pointer, this operation is semantically the same as creating a new /// pointer, this operation is semantically the same as creating a new
/// fat pointer with the data pointer value of `self` but the metadata of /// fat pointer with the data pointer value of `self` but the metadata of
/// `val`. /// `meta`.
/// ///
/// # Examples /// # Examples
/// ///

4
library/core/src/ptr/mut_ptr.rs
View File

@ -60,14 +60,14 @@ impl<T: ?Sized> *mut T {
/// Use the pointer value in a new pointer of another type. /// Use the pointer value in a new pointer of another type.
/// ///
/// In case `val` is a (fat) pointer to an unsized type, this operation /// In case `meta` is a (fat) pointer to an unsized type, this operation
/// will ignore the pointer part, whereas for (thin) pointers to sized /// will ignore the pointer part, whereas for (thin) pointers to sized
/// types, this has the same effect as a simple cast. /// types, this has the same effect as a simple cast.
/// ///
/// The resulting pointer will have provenance of `self`, i.e., for a fat /// The resulting pointer will have provenance of `self`, i.e., for a fat
/// pointer, this operation is semantically the same as creating a new /// pointer, this operation is semantically the same as creating a new
/// fat pointer with the data pointer value of `self` but the metadata of /// fat pointer with the data pointer value of `self` but the metadata of
/// `val`. /// `meta`.
/// ///
/// # Examples /// # Examples
/// ///