Struct bevy_internal::ecs::storage::BlobVec

pub struct BlobVec { /* private fields */ }

A flat, type-erased data storage type

Used to densely store homogeneous ECS data.

Implementations

impl BlobVec

pub fn new(
    item_layout: Layout,
    drop: unsafe fn(*mut u8),
    capacity: usize
) -> BlobVec

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn capacity(&self) -> usize

pub fn reserve_exact(&mut self, additional: usize)

pub unsafe fn initialize_unchecked(&mut self, index: usize, value: *mut u8)

Safety

• index must be in bounds
• the memory in the BlobVec starting at index index, of a size matching this BlobVec’s item_layout, must have been previously allocated, but not initialized yet
• the memory at *value must be previously initialized with an item matching this BlobVec’s item_layout
• the item that was stored in *value is left logically uninitialised/moved out of after calling this function, and as such should not be used or dropped by the caller.

pub unsafe fn replace_unchecked(&mut self, index: usize, value: *mut u8)

Safety

• index must be in-bounds
• the memory in the BlobVec starting at index index, of a size matching this BlobVec’s item_layout, must have been previously initialized with an item matching this BlobVec’s item_layout
• the memory at *value must also be previously initialized with an item matching this BlobVec’s item_layout
• the item that was stored in *value is left logically uninitialised/moved out of after calling this function, and as such should not be used or dropped by the caller.

pub unsafe fn push_uninit(&mut self) -> usize

Increases the length by one (and grows the vec if needed) with uninitialized memory and returns the index

Safety

the newly allocated space must be immediately populated with a valid value

pub unsafe fn set_len(&mut self, len: usize)

Safety

len must be <= capacity. if length is decreased, “out of bounds” items must be dropped. Newly added items must be immediately populated with valid values and length must be increased. For better unwind safety, call BlobVec::set_len after populating a new value.

pub unsafe fn swap_remove_and_forget_unchecked(
    &mut self,
    index: usize
) -> *mut u8

Performs a “swap remove” at the given index, which removes the item at index and moves the last item in the BlobVec to index (if index is not the last item). It is the caller’s responsibility to drop the returned pointer, if that is desirable.

Safety

It is the caller’s responsibility to ensure that index is < self.len() Callers should only access the returned pointer immediately after calling this function.

pub unsafe fn swap_remove_and_drop_unchecked(&mut self, index: usize)

Safety

index must be in-bounds

pub unsafe fn get_unchecked(&self, index: usize) -> *mut u8

Safety

It is the caller’s responsibility to ensure that index is < self.len()

pub unsafe fn get_ptr(&self) -> NonNull<u8>

Gets a pointer to the start of the vec

Safety

must ensure rust mutability rules are not violated

pub fn clear(&mut self)

Trait Implementations

impl Debug for BlobVec

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Drop for BlobVec

fn drop(&mut self)

Executes the destructor for this type.