Small doc comments for raw pointer wrappers

This commit is contained in:
Nathan Whitaker 2022-08-20 14:05:12 -07:00
parent 42d2768d3b
commit 6b6aeb6cf6
1 changed files with 4 additions and 0 deletions

View File

@ -1,6 +1,7 @@
use std::{marker::PhantomData, ptr::NonNull};
#[repr(transparent)]
/// A raw pointer that owns its pointee
pub(crate) struct Own<T>
where
T: ?Sized,
@ -58,6 +59,7 @@ where
}
#[repr(transparent)]
/// A raw pointer that represents a shared borrow of its pointee
pub(crate) struct Ref<'a, T>
where
T: ?Sized,
@ -118,6 +120,8 @@ where
}
}
#[repr(transparent)]
/// A raw pointer that represents a unique borrow of its pointee
pub(crate) struct Mut<'a, T>
where
T: ?Sized,