Struct voladdress::VolGrid2d

#[repr(transparent)]
pub struct VolGrid2d<T, R, W, const WIDTH: usize, const HEIGHT: usize> { /* private fields */ }

A 2D version of VolBlock, with a const generic WIDTH and HEIGHT.

This is intended for “video-like” memory that is better to logically access with an x and y position rather than a single i index. It’s just an alternative way to manage a VolBlock.

Generic Parameters

• T / R / W: These parameters are applied to the VolAddress type returned when accessing the block in any way (indexing, iteration, etc).
• WIDTH / HEIGHT: the matrix width and height, the total element count is WIDTH * HEIGHT.

Safety

• This type stores a base VolAddress internally, and so you must follow all of those safety rules. Notably, the base address must never be zero.
• The address space must legally contain WIDTH * HEIGHT contiguous values of the T type, starting from the base address.
• The memory block must not wrap around past the end of the address space.

Implementations

impl<T, R, W, const WIDTH: usize, const HEIGHT: usize> VolGrid2d<T, R, W, WIDTH, HEIGHT>

pub const unsafe fn new(address: usize) -> Self

Converts the address into a VolGrid2d

Safety

The given address must be a valid VolAddress at each position in the grid, as if you were making a VolBlock<T,R,W,{WIDTH * HEIGHT}>.

pub const fn from_block<const B: usize>(block: VolBlock<T, R, W, B>) -> Self

Creates a VolGrid2d from an appropriately sized VolBlock.

Panics

When B != WIDTH * HEIGHT. Note that such a panic should happen at compile time.

pub const fn into_block<const B: usize>(self) -> VolBlock<T, R, W, B>

Turn a VolGrid2d into its VolBlock equivalent.

Panics

When B != WIDTH * HEIGHT. Note that such a panic should happen at compile time.

pub const fn get(self, x: usize, y: usize) -> Option<VolAddress<T, R, W>>

Gets the address of the (x,y) given.

Returns None if either coordinate it out of bounds.

pub const fn index(self, x: usize, y: usize) -> VolAddress<T, R, W>

Indexes the address of the (x,y) given.

Panics

• If either coordinate it out of bounds this will panic.

pub const fn get_row(self, y: usize) -> Option<VolBlock<T, R, W, WIDTH>>

Get a single row of the grid as a VolBlock.

pub const fn as_usize(self) -> usize

Converts the VolGrid2d the usize for the start of the grid.

Trait Implementations

impl<T, R, W, const WIDTH: usize, const HEIGHT: usize> Clone for VolGrid2d<T, R, W, WIDTH, HEIGHT>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Hash, R: Hash, W: Hash, const WIDTH: usize, const HEIGHT: usize> Hash for VolGrid2d<T, R, W, WIDTH, HEIGHT>

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<T: Ord, R: Ord, W: Ord, const WIDTH: usize, const HEIGHT: usize> Ord for VolGrid2d<T, R, W, WIDTH, HEIGHT>

fn cmp(&self, other: &VolGrid2d<T, R, W, WIDTH, HEIGHT>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq, R: PartialEq, W: PartialEq, const WIDTH: usize, const HEIGHT: usize> PartialEq<VolGrid2d<T, R, W, WIDTH, HEIGHT>> for VolGrid2d<T, R, W, WIDTH, HEIGHT>

fn eq(&self, other: &VolGrid2d<T, R, W, WIDTH, HEIGHT>) -> 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<T: PartialOrd, R: PartialOrd, W: PartialOrd, const WIDTH: usize, const HEIGHT: usize> PartialOrd<VolGrid2d<T, R, W, WIDTH, HEIGHT>> for VolGrid2d<T, R, W, WIDTH, HEIGHT>

fn partial_cmp( &self, other: &VolGrid2d<T, R, W, WIDTH, HEIGHT> ) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T, R, W, const WIDTH: usize, const HEIGHT: usize> Copy for VolGrid2d<T, R, W, WIDTH, HEIGHT>

impl<T: Eq, R: Eq, W: Eq, const WIDTH: usize, const HEIGHT: usize> Eq for VolGrid2d<T, R, W, WIDTH, HEIGHT>

impl<T, R, W, const WIDTH: usize, const HEIGHT: usize> StructuralEq for VolGrid2d<T, R, W, WIDTH, HEIGHT>

impl<T, R, W, const WIDTH: usize, const HEIGHT: usize> StructuralPartialEq for VolGrid2d<T, R, W, WIDTH, HEIGHT>