Struct block_grid::BlockMut

pub struct BlockMut<'a, T, B: BlockDim> { /* fields omitted */ }

A mutable view of a 2D block contiguous in memory.

Can be obtained via BlockIterMut, which is created by calling BlockGrid::block_iter_mut.

Implementations

impl<'a, T, B: BlockDim> BlockMut<'a, T, B>

pub fn coords(&self) -> Coords

Returns the coordinates of the entire block.

Block coordinates mean that the (i, j) refers to the i-th row of blocks and the j-th block in that row. If you need the coordinates of the first (top-left) element, use starts_at instead.

pub fn starts_at(&self) -> Coords

Returns of the coordinates of the first (top-left) element in the block.

pub fn contains(&self, (row, col): Coords) -> bool

Returns true if the given coordinates are valid.

pub fn get(&self, coords: Coords) -> Option<&T>

Returns a reference to the element at the given coordinates, or None if they are out-of-bounds.

pub fn get_mut(&mut self, coords: Coords) -> Option<&mut T>

Returns a mutable reference to the element at the given coordinates, or None if they are out-of-bounds.

pub unsafe fn get_unchecked(&self, coords: Coords) -> &T

Returns a reference to the element at the given coordinates, without bounds checking.

Safety

Calling this method with out-of-bounds coordinates is undefined-behaviour.

pub unsafe fn get_unchecked_mut(&mut self, coords: Coords) -> &mut T

Returns a mutable reference to the element at the given coordinates, without bounds checking.

Safety

Calling this method with out-of-bounds coordinates is undefined-behaviour.

Trait Implementations

impl<'a, T: Debug, B: Debug + BlockDim> Debug for BlockMut<'a, T, B>

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

Formats the value using the given formatter.

impl<'a, T, B: BlockDim> Index<(usize, usize)> for BlockMut<'a, T, B>

type Output = T

The returned type after indexing.

fn index(&self, coords: Coords) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T, B: BlockDim> IndexMut<(usize, usize)> for BlockMut<'a, T, B>

fn index_mut(&mut self, coords: Coords) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.