Struct WindowMut 

pub struct WindowMut<'t, TElement: Copy, TGrid: Grid<TElement>> { /* private fields */ }

A window into a 2D grid.

All operations are done directly on the contained reference, but translated to where the window is.

Implementations

impl<'t, TElement: Copy, TGrid: Grid<TElement>> WindowMut<'t, TElement, TGrid>

pub fn new( grid: &'t mut TGrid, xs: impl RangeBounds<usize>, ys: impl RangeBounds<usize>, ) -> Option<Self>

Create a new window into grid.

pub fn window( &self, xs: impl RangeBounds<usize>, ys: impl RangeBounds<usize>, ) -> Option<Window<'_, TElement, TGrid>>

Creates a window into the window.

Returns None in case the window does not fit.

pub fn split_horizontal( &'t self, left_width: usize, ) -> Option<(Window<'t, TElement, TGrid>, Window<'t, TElement, TGrid>)>

Splits the window horizontally, returning windows to the left and right parts.

The right window fills the remaining width, which may be zero.

Returns None for out-of-bounds.

pub fn split_vertical( &'t self, top_height: usize, ) -> Option<(Window<'t, TElement, TGrid>, Window<'t, TElement, TGrid>)>

Splits the window vertically, returning windows to the top and bottom parts.

The bottom window fills the remaining height, which may be zero.

Returns None for out-of-bounds.

impl<TElement: Copy, TGrid: GridMut<TElement>> WindowMut<'_, TElement, TGrid>

pub fn window_mut( &mut self, xs: impl RangeBounds<usize>, ys: impl RangeBounds<usize>, ) -> Option<WindowMut<'_, TElement, TGrid>>

Creates a mutable window into the grid.

Returns None in case the window does not fit.

pub fn split_horizontal_mut<'t>( &'t mut self, left_width: usize, ) -> Option<(WindowMut<'t, TElement, TGrid>, WindowMut<'t, TElement, TGrid>)>

Splits the window horizontally, returning windows to the left and right parts.

The right window fills the remaining width, which may be zero.

Returns None for out-of-bounds.

pub fn split_vertical_mut<'t>( &'t mut self, top_height: usize, ) -> Option<(WindowMut<'t, TElement, TGrid>, WindowMut<'t, TElement, TGrid>)>

Splits the window vertically, returning windows to the top and bottom parts.

The bottom window fills the remaining height, which may be zero.

Returns None for out-of-bounds.

Trait Implementations

impl<'t, TElement: Debug + Copy, TGrid: Debug + Grid<TElement>> Debug for WindowMut<'t, TElement, TGrid>

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

Formats the value using the given formatter.

impl<TElement: Copy, TGrid: Grid<TElement>> Grid<TElement> for WindowMut<'_, TElement, TGrid>

fn get_optional(&self, x: usize, y: usize) -> Option<TElement>

Get the current value at the specified position if the position is inside of bounds

fn width(&self) -> usize

the size in x-direction

fn height(&self) -> usize

the height in y-direction

fn get(&self, x: usize, y: usize) -> T

Get the current value at the specified position

fn is_in_bounds(&self, x: usize, y: usize) -> bool

Checks whether the specified signed position is in grid bounds

fn assert_in_bounds(&self, x: usize, y: usize)

Asserts that the specified unsigned position is in grid bounds.

fn get_row(&self, y: usize) -> Option<Vec<T>>

Copies a row from the grid.

fn get_col(&self, x: usize) -> Option<Vec<T>>

Copies a column from the grid.

impl<TElement: Copy, TGrid: GridMut<TElement>> GridMut<TElement> for WindowMut<'_, TElement, TGrid>

fn set_optional(&mut self, x: usize, y: usize, value: TElement) -> bool

Sets the value at the specified position if the position is inside of bounds

fn fill(&mut self, value: TElement)

Sets all cells in the grid to the specified value

fn set(&mut self, x: usize, y: usize, value: T)

Sets the value at the specified position

fn deref_assign<O: Grid<T>>(&mut self, other: &O)

Fills the grid with the values from the provided grid.

fn set_col(&mut self, x: usize, col: &[T]) -> Result<(), SetValueSeriesError>

Overwrites a column in the grid.

fn set_row(&mut self, y: usize, row: &[T]) -> Result<(), SetValueSeriesError>

Overwrites a row in the grid.