pub struct OwningPtr<'a, A: IsAligned = Aligned>(/* private fields */);
Expand description
Type-erased Box-like pointer to some unknown type chosen when constructing this type.
Conceptually represents ownership of whatever data is being pointed to and so is
responsible for calling its Drop
impl. This pointer is not responsible for freeing
the memory pointed to by this pointer as it may be pointing to an element in a Vec
or
to a local in a function etc.
This type tries to act “borrow-like” like which means that:
- Pointer should be considered exclusive and mutable. It cannot be cloned as this would lead to aliased mutability and potentially use after free bugs.
- 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 ManuallyDrop<dyn Any>
but
without the metadata and able to point to data that does not correspond to a Rust type.
Implementations§
source§impl<'a> OwningPtr<'a, Aligned>
impl<'a> OwningPtr<'a, Aligned>
sourcepub fn to_unaligned(self) -> OwningPtr<'a, Unaligned>
pub fn to_unaligned(self) -> OwningPtr<'a, Unaligned>
Removes the alignment requirement of this pointer
source§impl<A: IsAligned> OwningPtr<'_, A>
impl<A: IsAligned> OwningPtr<'_, 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> OwningPtr<'a, A>
impl<'a, A: IsAligned> OwningPtr<'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 thisOwningPtr
will stay valid and nothing else can read or mutate the pointee while thisOwningPtr
is live.