Skip to main content

PtrID

Struct PtrID 

Source
pub struct PtrID<E, P> { /* private fields */ }
Expand description

Pointer-backed ID referencing a Unit<E> inside an EntityAlloc.

PtrID is a thin, non-null wrapper around a raw NonNull<Unit<E>>. It is intended for fast, pointer-based access to entities. The struct carries a PhantomData<P> to associate the allocation policy at the type level.

Safety / 注意事项:

  • PtrID assumes the pointer points to a properly initialized Unit<E>.
  • Many operations are unsafe without validity checks; prefer the safe conversion methods in IEntityAllocID/EntityAlloc that validate generation/index when necessary.

Implementations§

Source§

impl<E, P: IAllocPolicy> PtrID<E, P>

Source

pub fn check_validity(&self, alloc: &EntityAlloc<E, P>) -> bool

Check whether this pointer currently refers to a valid allocated unit.

Returns true if the pointer can be resolved to a live GenIndex in the provided alloc. This performs the same generation/index check used by other conversion helpers.

检查此指针在给定的 EntityAlloc 中是否仍然有效(未被释放或越界)。

Source

pub unsafe fn direct_deref<'a>(self) -> Option<&'a E>

Directly dereference the underlying unit, without validity check.

§Safety

The caller must ensure the pointer is valid and the unit is initialized. 不做有效性检查,调用者必须保证指针有效且单元已初始化。

Source

pub unsafe fn direct_deref_mut<'a>(self) -> Option<&'a mut E>

Directly dereference the underlying unit mutably, without validity check.

§Safety

The caller must ensure exclusive access and that the pointer is valid. 不做有效性检查,调用者必须保证对该内存拥有唯一可变访问权。

Trait Implementations§

Source§

impl<E, P> Clone for PtrID<E, P>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<E, P> Debug for PtrID<E, P>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<E, P> From<NonNull<Unit<E>>> for PtrID<E, P>

Source§

fn from(ptr: NonNull<Unit<E>>) -> Self

Converts to this type from the input type.
Source§

impl<E, P> Hash for PtrID<E, P>

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<E, P: IAllocPolicy> IEntityAllocID<E, P> for PtrID<E, P>

Source§

fn from_ptr(_: &EntityAlloc<E, P>, ptr: PtrID<E, P>) -> Option<Self>

Create an ID from a pointer-backed ID, validating generation/index.
Source§

fn from_index( alloc: &EntityAlloc<E, P>, indexed: IndexedID<E, P>, ) -> Option<Self>

Create an ID from an index-backed ID, validating generation/index.
Source§

fn try_deref(self, alloc: &EntityAlloc<E, P>) -> Option<&E>

Try to dereference the entity this ID points to, returning None if invalid.
Source§

fn try_deref_mut(self, alloc: &mut EntityAlloc<E, P>) -> Option<&mut E>

Try to mutably dereference the entity this ID points to, returning None if invalid.
Source§

fn to_index(self, alloc: &EntityAlloc<E, P>) -> Option<IndexedID<E, P>>

Convert this ID to an index-backed ID, validating generation/index.
Source§

fn to_ptr(self, _alloc: &EntityAlloc<E, P>) -> Option<PtrID<E, P>>

Convert this ID to a pointer-backed ID, validating generation/index.
Source§

fn allocate_from(alloc: &EntityAlloc<E, P>, val: E) -> Self

Allocate a new entity in the given allocator and return its ID. NOTE that MTB::Entity library is ID-driven; allocation and deallocation must be done through IDs.
Source§

fn free(self, alloc: &mut EntityAlloc<E, P>) -> Option<E>

Free the referenced entity and return its owned value if successful. Read more
Source§

fn deref(self, alloc: &EntityAlloc<E, P>) -> &E

Directly dereference the entity this ID points to, panicking if invalid.
Source§

fn deref_mut(self, alloc: &mut EntityAlloc<E, P>) -> &mut E

Directly mutably dereference the entity this ID points to, panicking if invalid.
Source§

impl<E, P: IAllocPolicy> IPoliciedID for PtrID<E, P>

Source§

type ObjectT = E

The object type this ID references.
Source§

type PolicyT = P

The allocation policy this ID is associated with.
Source§

type BackID = PtrID<E, P>

The backend ID type that implements the actual logic.
Source§

fn from_backend(ptr: Self::BackID) -> Self

Create this ID from its backend representation.
Source§

fn into_backend(self) -> Self::BackID

Convert this ID into its backend representation.
Source§

fn try_deref_alloc(self, alloc: &IDBoundAlloc<Self>) -> Option<&Self::ObjectT>

Try to dereference the object this ID points to, returning None if invalid.
Source§

fn try_deref_alloc_mut( self, alloc: &mut IDBoundAlloc<Self>, ) -> Option<&mut Self::ObjectT>

Try to mutably dereference the object this ID points to, returning None if invalid.
Source§

fn deref_alloc(self, alloc: &IDBoundAlloc<Self>) -> &Self::ObjectT

Dereference the object this ID points to, panicking if invalid.
Source§

fn deref_alloc_mut(self, alloc: &mut IDBoundAlloc<Self>) -> &mut Self::ObjectT

Mutably dereference the object this ID points to, panicking if invalid.
Source§

impl<E, P> Ord for PtrID<E, P>

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<E, P> PartialEq for PtrID<E, P>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<E, P> PartialOrd for PtrID<E, P>

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<E, P> Pointer for PtrID<E, P>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<E, P> Copy for PtrID<E, P>

Source§

impl<E, P> Eq for PtrID<E, P>

Source§

impl<E: Send, P> Send for PtrID<E, P>

Source§

impl<E: Sync, P> Sync for PtrID<E, P>

Auto Trait Implementations§

§

impl<E, P> Freeze for PtrID<E, P>

§

impl<E, P> RefUnwindSafe for PtrID<E, P>

§

impl<E, P> Unpin for PtrID<E, P>
where P: Unpin,

§

impl<E, P> UnwindSafe for PtrID<E, P>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.