From 6b6aeb6cf6c9a9ec2f2571468523670f9b885671 Mon Sep 17 00:00:00 2001 From: Nathan Whitaker Date: Sat, 20 Aug 2022 14:05:12 -0700 Subject: [PATCH] Small doc comments for raw pointer wrappers --- src/eyreish/ptr.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/eyreish/ptr.rs b/src/eyreish/ptr.rs index b847963..4309c5a 100644 --- a/src/eyreish/ptr.rs +++ b/src/eyreish/ptr.rs @@ -1,6 +1,7 @@ use std::{marker::PhantomData, ptr::NonNull}; #[repr(transparent)] +/// A raw pointer that owns its pointee pub(crate) struct Own 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,