ThinBox: Add intra-doc-links for Metadata

This commit is contained in:
est31 2023-01-20 08:07:45 +01:00
parent aaa9bb9e7b
commit 4127988317

View File

@ -48,7 +48,7 @@ unsafe impl<T: ?Sized + Sync> Sync for ThinBox<T> {}
#[unstable(feature = "thin_box", issue = "92791")] #[unstable(feature = "thin_box", issue = "92791")]
impl<T> ThinBox<T> { impl<T> ThinBox<T> {
/// Moves a type to the heap with its `Metadata` stored in the heap allocation instead of on /// Moves a type to the heap with its [`Metadata`] stored in the heap allocation instead of on
/// the stack. /// the stack.
/// ///
/// # Examples /// # Examples
@ -59,6 +59,8 @@ impl<T> ThinBox<T> {
/// ///
/// let five = ThinBox::new(5); /// let five = ThinBox::new(5);
/// ``` /// ```
///
/// [`Metadata`]: core::ptr::Pointee::Metadata
#[cfg(not(no_global_oom_handling))] #[cfg(not(no_global_oom_handling))]
pub fn new(value: T) -> Self { pub fn new(value: T) -> Self {
let meta = ptr::metadata(&value); let meta = ptr::metadata(&value);
@ -69,7 +71,7 @@ impl<T> ThinBox<T> {
#[unstable(feature = "thin_box", issue = "92791")] #[unstable(feature = "thin_box", issue = "92791")]
impl<Dyn: ?Sized> ThinBox<Dyn> { impl<Dyn: ?Sized> ThinBox<Dyn> {
/// Moves a type to the heap with its `Metadata` stored in the heap allocation instead of on /// Moves a type to the heap with its [`Metadata`] stored in the heap allocation instead of on
/// the stack. /// the stack.
/// ///
/// # Examples /// # Examples
@ -80,6 +82,8 @@ impl<Dyn: ?Sized> ThinBox<Dyn> {
/// ///
/// let thin_slice = ThinBox::<[i32]>::new_unsize([1, 2, 3, 4]); /// let thin_slice = ThinBox::<[i32]>::new_unsize([1, 2, 3, 4]);
/// ``` /// ```
///
/// [`Metadata`]: core::ptr::Pointee::Metadata
#[cfg(not(no_global_oom_handling))] #[cfg(not(no_global_oom_handling))]
pub fn new_unsize<T>(value: T) -> Self pub fn new_unsize<T>(value: T) -> Self
where where