Crate bevy_ptr

Bevy Ptr

The bevy_ptr crate provides low-level abstractions for working with pointers in a more safe way than using rust’s raw pointers.

Rust has lifetimed and typed references (&'a T), unlifetimed and typed references (*const T), but no lifetimed but untyped references. bevy_ptr adds them, called Ptr<'a>, PtrMut<'a> and OwningPtr<'a>. These types are lifetime-checked so can never lead to problems like use-after-frees and must always point to valid data.

Structs

• Aligned
  Used as a type argument to Ptr, PtrMut and OwningPtr to specify that the pointer is aligned.
• OwningPtr
  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.
• Ptr
  Type-erased borrow of some unknown type chosen when constructing this type.
• PtrMut
  Type-erased mutable borrow of some unknown type chosen when constructing this type.
• ThinSlicePtr
  Conceptually equivalent to &'a [T] but with length information cut out for performance reasons
• Unaligned
  Used as a type argument to Ptr, PtrMut and OwningPtr to specify that the pointer is not aligned.

Traits

• IsAligned
  Trait that is only implemented for Aligned and Unaligned to work around the lack of ability to have const generics of an enum.
• UnsafeCellDeref
  Extension trait for helper methods on UnsafeCell

Functions

• dangling_with_align
  Creates a dangling pointer with specified alignment. See NonNull::dangling.