Struct Allocation

pub struct Allocation {
    pub offset: u32,
    pub size: NonZero<u32>,
}

Metadata containing information about an allocation

This is a small Copy type. It also provides a niche, so that Option<Allocation> has the same size as Allocation.

assert_eq!(size_of::<Allocation>(), size_of::<u64>());
assert_eq!(size_of::<Option<Allocation>>(), size_of::<Allocation>());

Fields

offset: u32

The location of this allocation within the buffer

size: NonZero<u32>

The size of this allocation

Implementations

impl Allocation

pub fn offset(&self) -> u32

Get the offset of the allocation

This is just a wrapper for allocation.offset for symmetry with size.

pub fn size(&self) -> u32

Get the size of the allocation

This is just sugar for allocation.size.get().

pub fn range(&self) -> Range<usize>

Get a Range<usize> from offset to offset + size

This can be used to directly index a buffer.

For example:

let buffer: Vec<usize> = (0..100).collect();
let allocation = Allocation {
  offset: 25,
  size: NonZero::new(4).unwrap()
};

let region = &buffer[allocation.range()];

assert_eq!(region, &[25, 26, 27, 28]);

Trait Implementations

impl Clone for Allocation

fn clone(&self) -> Allocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Allocation

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

Formats the value using the given formatter.

impl Hash for Allocation

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 Ord for Allocation

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Allocation

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

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

const 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 PartialOrd for Allocation

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Allocation

impl Eq for Allocation

impl StructuralPartialEq for Allocation