Struct ValueStorage 

pub struct ValueStorage<T: Copy> {
    pub inner: ValueStorageInner<T>,
}

Generic storage for PyBevy value types (Copy types like Vec3, Quat, etc.)

Supports two modes:

• Owned: Python-created value, stored directly (no heap allocation)
• Borrowed: Reference to field in a component (e.g., transform.translation)

Type Parameters

• T: The value type (must implement Copy for efficient storage)

Safety

Borrowed variant contains a raw pointer to value data in a component. The ValidityFlagWithMode ensures this pointer is only dereferenced during system execution when the pointer is guaranteed to be valid, and tracks whether the component was accessed mutably or immutably.

Fields

inner: ValueStorageInner<T>

Implementations

impl<T: Copy> ValueStorage<T>

pub const fn owned(value: T) -> Self

Create owned value storage

pub fn as_ref(&self) -> Result<&T, StorageError>

Get immutable reference to the value, checking validity

Errors

Returns StorageError::InvalidAccess if the borrowed reference is no longer valid (i.e., accessed outside of system execution context)

pub fn as_mut(&mut self) -> Result<&mut T, StorageError>

Get mutable reference to the value, checking validity and write permission

Errors

Returns StorageError if:

• The borrowed reference is no longer valid
• The value was borrowed immutably (Ref) but mutable access is attempted

pub fn get(&self) -> Result<T, StorageError>

Get the current value (returns a copy)

For owned values, returns a copy. For borrowed values, copies the current value.

Errors

Returns error if borrowed value is no longer valid

pub fn borrow_field<F: Clone, S>( &self, field_accessor: impl Fn(&T) -> &F, ) -> Result<S, StorageError>

where S: BorrowableStorage<F>,

Helper to borrow a field from the value storage

This reduces boilerplate in field getters by unifying the owned/borrowed cases. Similar to ComponentStorage::borrow_field, but works with ValueStorage.

For owned storage (including read-only snapshots), returns a read-only snapshot of the field. For borrowed storage, returns a borrowed pointer into the underlying data.

pub fn borrow_field_as<F: Clone, S, W>( &self, field_accessor: impl Fn(&T) -> &F, ) -> Result<W, StorageError>

where S: BorrowableStorage<F>, W: FromBorrowedStorage<S>,

Helper to borrow a field and wrap it in the final Python type

Combines borrow_field with FromBorrowedStorage::from_borrowed to reduce boilerplate.

Trait Implementations

impl<T: Copy> BorrowableStorage<T> for ValueStorage<T>

unsafe fn borrowed(ptr: *mut T, validity: ValidityFlagWithMode) -> Self

Create a borrowed storage from a raw pointer and validity flag

fn snapshot(value: &T) -> Self

Create a read-only owned snapshot (copy) of the given value.

impl<T: Copy> Clone for ValueStorage<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Copy> Debug for ValueStorage<T>

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

Formats the value using the given formatter.

impl<T> PartialEq for ValueStorage<T>

where T: PartialEq + Copy,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Copy + Send> Send for ValueStorage<T>

impl<T: Copy + Sync> Sync for ValueStorage<T>