Struct bevy_ptr::Ptr

pub struct Ptr<'a>(_, _);

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.

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

impl Ptr<'_>

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.

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.

pub unsafe fn new(inner: NonNull<u8>) -> Self

Creates a new instance from a raw pointer.

Safety

The lifetime for the returned item must not exceed the lifetime inner is valid for

impl<'a> Ptr<'a>

pub unsafe fn assert_unique(self) -> PtrMut<'a>

Transforms this Ptr into an PtrMut

Safety

Another PtrMut for the same Ptr must not be created until the first is dropped.

pub unsafe fn deref<T>(self) -> &'a T

Transforms this Ptr<T> into a &T with the same lifetime

Safety

Must point to a valid T

pub fn as_ptr(self) -> *mut u8

Gets the underlying pointer, erasing the associated lifetime.

If possible, it is strongly encouraged to use deref over this function, as it retains the lifetime.

Trait Implementations

impl<'a> Clone for Ptr<'a>

fn clone(&self) -> Ptr<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for Ptr<'a>