Struct MutSlice2

pub struct MutSlice2<'a, T>(/* private fields */);

A mutable rectangular view to a region of a Buf2, a Slice2, or in general any &[T] slice of memory.

Implementations

impl<'a, T> MutSlice2<'a, T>

pub fn new(dims: Dims, stride: u32, data: &'a mut [T]) -> Self

Returns a new MutSlice2 view to data with dimensions w and h and stride stride.

See Slice2::new for more information.

Methods from Deref<Target = Inner<T, &'a mut [T]>>

pub fn width(&self) -> u32

Returns the width of self.

pub fn height(&self) -> u32

Returns the height of self.

pub fn stride(&self) -> u32

Returns the stride of self.

pub fn is_contiguous(&self) -> bool

Returns whether the rows of self are stored as one contiguous slice, without gaps between rows.

Buf2 instances are always contiguous. A Slice2 or MutSlice2 instance is contiguous if its width equals its stride, if its height is 1, or if it is empty.

pub fn is_empty(&self) -> bool

Returns whether self contains no elements.

pub fn as_slice2(&self) -> Slice2<'_, T>

Borrows self as a Slice2.

pub fn slice(&self, rect: impl Into<Rect>) -> Slice2<'_, T>

Returns a borrowed rectangular slice of self.

Panics

If any part of rect is outside the bounds of self.

pub fn get(&self, pos: impl Into<Vec2u>) -> Option<&T>

Returns a reference to the element at pos, or None if pos is out of bounds.

pub fn rows(&self) -> impl Iterator<Item = &[T]>

Returns an iterator over the rows of self as &[T] slices.

The length of each slice equals self.width().

pub fn iter(&self) -> impl Iterator<Item = &T>

Returns an iterator over all the elements of self in row-major order.

First returns the elements on row 0 from left to right, followed by the elements on row 1, and so on.

pub fn as_mut_slice2(&mut self) -> MutSlice2<'_, T>

Returns a mutably borrowed rectangular slice of self.

pub fn rows_mut(&mut self) -> impl Iterator<Item = &mut [T]>

Returns an iterator over the rows of this buffer as &mut [T].

The length of each slice equals self.width().

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

Returns an iterator over all the elements of self in row-major order: first the elements on row 0 from left to right, followed by the elements on row 1, and so on.

pub fn fill(&mut self, val: T)

where T: Clone,

Fills self with clones of val.

pub fn fill_with<F>(&mut self, fill_fn: F)

where F: Copy + FnMut(u32, u32) -> T,

Fills self by invoking f(x, y) for every element, where x and y are the column and row of the element, respectively.

pub fn copy_from(&mut self, src: impl AsSlice2<T>)

where T: Copy,

Copies each element in src to the same position in self.

This operation is often called “blitting”.

Panics

if the dimensions of self and src don’t match.

pub fn get_mut(&mut self, pos: impl Into<Vec2u>) -> Option<&mut T>

Returns a mutable reference to the element at pos, or None if pos is out of bounds.

pub fn slice_mut(&mut self, rect: impl Into<Rect>) -> MutSlice2<'_, T>

Returns a mutably borrowed rectangular slice of self.

Panics

If any part of rect is outside the bounds of self.

Trait Implementations

impl<T> AsMutSlice2<T> for MutSlice2<'_, T>

fn as_mut_slice2(&mut self) -> MutSlice2<'_, T>

Returns a mutably borrowed MutSlice2 view of Self.

impl<T> AsSlice2<T> for MutSlice2<'_, T>

fn as_slice2(&self) -> Slice2<'_, T>

Returns a borrowed Slice2 view of Self.

impl<T> Debug for MutSlice2<'_, T>

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

Formats the value using the given formatter.

impl<'a, T> Deref for MutSlice2<'a, T>

type Target = Inner<T, &'a mut [T]>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T> DerefMut for MutSlice2<'a, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.