Struct vulkano::memory::allocator::AllocationHandle

pub struct AllocationHandle(/* private fields */);

An opaque handle identifying an allocation inside an allocator.

Implementations

impl AllocationHandle

pub const fn null() -> Self

Creates a null AllocationHandle.

Use this if you don’t have anything that you need to associate with the allocation.

pub const fn from_ptr(ptr: *mut ()) -> Self

Stores a pointer in an AllocationHandle.

Use this if you want to associate an allocation with some (host) heap allocation.

pub const fn from_index(index: usize) -> Self

Stores an index inside an AllocationHandle.

Use this if you want to associate an allocation with some index.

pub const fn as_ptr(self) -> *mut ()

Retrieves a previously-stored pointer from the AllocationHandle.

If this handle hasn’t been created using from_ptr then this will return an invalid pointer, dereferencing which is undefined behavior.

pub const fn as_index(self) -> usize

Retrieves a previously-stored index from the AllocationHandle.

If this handle hasn’t been created using from_index then this will return a bogus result.

Trait Implementations

impl Clone for AllocationHandle

fn clone(&self) -> AllocationHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AllocationHandle

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

Formats the value using the given formatter.

impl Hash for AllocationHandle

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq for AllocationHandle

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for AllocationHandle

impl Eq for AllocationHandle

impl Send for AllocationHandle

impl StructuralEq for AllocationHandle

impl StructuralPartialEq for AllocationHandle

impl Sync for AllocationHandle