pub struct Ptr<'a, A: IsAligned = Aligned>(/* private fields */);
Expand description
Type-erased borrow of some unknown type chosen when constructing this type.
This type tries to act “borrow-like” which means that:
- It should be considered immutable: its target must not be changed while this pointer is alive.
- It must always points to a valid value of whatever the pointee type is.
- The lifetime
'a
accurately represents how long the pointer is valid for. - Must be sufficiently aligned for the unknown pointee type.
It may be helpful to think of this type as similar to &'a dyn Any
but without
the metadata and able to point to data that does not correspond to a Rust type.
Implementations§
Source§impl<'a> Ptr<'a, Aligned>
impl<'a> Ptr<'a, Aligned>
Sourcepub fn to_unaligned(self) -> Ptr<'a, Unaligned>
pub fn to_unaligned(self) -> Ptr<'a, Unaligned>
Removes the alignment requirement of this pointer
Source§impl<A: IsAligned> Ptr<'_, A>
impl<A: IsAligned> Ptr<'_, A>
Sourcepub unsafe fn byte_offset(self, count: isize) -> Self
pub unsafe fn byte_offset(self, count: isize) -> Self
Calculates the offset from a pointer.
As the pointer is type-erased, there is no size information available. The provided
count
parameter is in raw bytes.
See also: ptr::offset
§Safety
- The offset cannot make the existing ptr null, or take it out of bounds for its allocation.
- If the
A
type parameter isAligned
then the offset must not make the resulting pointer be unaligned for the pointee type. - The value pointed by the resulting pointer must outlive the lifetime of this pointer.
Sourcepub unsafe fn byte_add(self, count: usize) -> Self
pub unsafe fn byte_add(self, count: usize) -> Self
Calculates the offset from a pointer (convenience for .offset(count as isize)
).
As the pointer is type-erased, there is no size information available. The provided
count
parameter is in raw bytes.
See also: ptr::add
§Safety
- The offset cannot make the existing ptr null, or take it out of bounds for its allocation.
- If the
A
type parameter isAligned
then the offset must not make the resulting pointer be unaligned for the pointee type. - The value pointed by the resulting pointer must outlive the lifetime of this pointer.
Source§impl<'a, A: IsAligned> Ptr<'a, A>
impl<'a, A: IsAligned> Ptr<'a, A>
Sourcepub unsafe fn new(inner: NonNull<u8>) -> Self
pub unsafe fn new(inner: NonNull<u8>) -> Self
Creates a new instance from a raw pointer.
§Safety
inner
must point to valid value of whatever the pointee type is.- If the
A
type parameter isAligned
theninner
must be sufficiently aligned for the pointee type. inner
must have correct provenance to allow reads of the pointee type.- The lifetime
'a
must be constrained such that thisPtr
will stay valid and nothing can mutate the pointee while thisPtr
is live except through anUnsafeCell
.
Sourcepub unsafe fn assert_unique(self) -> PtrMut<'a, A>
pub unsafe fn assert_unique(self) -> PtrMut<'a, A>
Trait Implementations§
impl<'a, A: Copy + IsAligned> Copy for Ptr<'a, A>
Auto Trait Implementations§
impl<'a, A> Freeze for Ptr<'a, A>
impl<'a, A> RefUnwindSafe for Ptr<'a, A>where
A: RefUnwindSafe,
impl<'a, A = Aligned> !Send for Ptr<'a, A>
impl<'a, A = Aligned> !Sync for Ptr<'a, A>
impl<'a, A> Unpin for Ptr<'a, A>where
A: Unpin,
impl<'a, A> UnwindSafe for Ptr<'a, A>where
A: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)