pub struct PtrMut<'a, A: IsAligned = Aligned>(/* private fields */);
Expand description
Type-erased mutable borrow of some unknown type chosen when constructing this type.
This type tries to act “borrow-like” which means that:
- Pointer is considered exclusive and mutable. It cannot be cloned as this would lead to aliased mutability.
- 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 mut dyn Any
but without
the metadata and able to point to data that does not correspond to a Rust type.
Implementations§
source§impl<'a> PtrMut<'a, Aligned>
impl<'a> PtrMut<'a, Aligned>
sourcepub fn to_unaligned(self) -> PtrMut<'a, Unaligned>
pub fn to_unaligned(self) -> PtrMut<'a, Unaligned>
Removes the alignment requirement of this pointer
source§impl<A: IsAligned> PtrMut<'_, A>
impl<A: IsAligned> PtrMut<'_, 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> PtrMut<'a, A>
impl<'a, A: IsAligned> PtrMut<'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 read and writes of the pointee type.- The lifetime
'a
must be constrained such that thisPtrMut
will stay valid and nothing else can read or mutate the pointee while thisPtrMut
is live.