Struct GridPlacer 

pub struct GridPlacer<'a> {
    state: &'a mut GridState,
    frame: Frame,
}

Places rectangles on a grid scope. Created by MenuBuilder::grid.

All coordinates are local to this scope, which makes grids combineable.

Fields

state: &'a mut GridState

frame: Frame

Implementations

impl<'a> GridPlacer<'a>

pub const fn width(&self) -> usize

The number of columns in this scope.

pub const fn height(&self) -> usize

The number of rows in this scope.

pub const fn full(&self) -> Rect

The rect covering this whole scope.

pub fn size_of(&self, rect: Rect) -> (usize, usize)

The resolved size of rect as (columns, rows), unbounded ends run to the edges.

Panics

If the rect does not fit this scope.

pub fn place( &mut self, rect: Rect, container: impl Into<ContainerRef>, ) -> PlacementBuilder<'_, 'a>

Starts placing slots for container over rect, first cell at container slot 0.

Configure the covered container slots with start_at or at_indices, the slot behavior with restrict, guard, display or kind, then commit with section, region or result.

fn place_section( &mut self, rect: Rect, container: ContainerRef, mapping: SlotMapping, kind: SectionKind, ) -> Region

Panics

If the rect exceeds this scope, overlaps another placement or subgrid, the container is too small, or an explicit index mapping does not match the rect’s cell count.

pub fn place_slots<S>( &mut self, rect: Rect, slots: impl IntoIterator<Item = S>, ) -> Region

where S: Slot + 'static,

Adds concrete pre-built slots over rect, consumed in row-major order.

The menu derives its lock set from each slot’s SlotStorage. Use place_boxed_slots for a heterogeneous or already-erased collection.

Panics

If the slot count differs from the rect’s cell count, or on the overlap/bounds conditions of place.

pub fn place_boxed_slots( &mut self, rect: Rect, slots: impl IntoIterator<Item = Box<dyn Slot>>, ) -> Region

Adds heterogeneous or already-erased slots over rect in row-major order.

Panics

If the slot count differs from the rect’s cell count, or on the overlap/bounds conditions of place.

fn place_result( &mut self, at: Rect, slot: ResultSlot, container: ContainerRef, ) -> Section

Panics

If the rect is not a single cell, or on the overlap/bounds conditions of a placement.

pub fn paint(&mut self, rect: Rect, stack: impl Into<ItemStack>)

Paints decoration over rect. Painted cells become locked display slots of one filler container.

Paint is the bottom layer. Placements and subgrids mask it regardless of call order, and the last paint on a cell wins.

Panics

If the rect exceeds this scope.

pub fn paint_all(&mut self, stack: impl Into<ItemStack>)

Paints the whole scope.

pub fn subgrid<R>( &mut self, rect: Rect, f: impl FnOnce(&mut GridPlacer<'_>) -> R, ) -> R

Runs f against the sub-area rect with its own local coordinates.

Self-contained. It must fully cover its own area, parent paint does not reach in, and nothing may be placed over it afterwards.

Panics

If the rect exceeds this scope or overlaps a placement or subgrid, or if f leaves cells uncovered.

pub fn carve_rows<R>( &mut self, count: usize, f: impl FnOnce(&mut GridPlacer<'_>) -> R, ) -> R

Carves the next count rows off this scope and runs f against them.

Panics

If carve_cols was already used here, if fewer than count rows remain, or on the subgrid conditions.

pub fn carve_cols<R>( &mut self, count: usize, f: impl FnOnce(&mut GridPlacer<'_>) -> R, ) -> R

Carves the next count columns off this scope and runs f against them.

Panics

If carve_rows was already used here, if fewer than count columns remain, or on the subgrid conditions.

pub fn rest<R>(&mut self, f: impl FnOnce(&mut GridPlacer<'_>) -> R) -> R

Carves everything remaining on the current axis and runs f against it.

Panics

If nothing remains to carve, or on the subgrid conditions.

fn carve<R>( &mut self, axis: Axis, count: usize, f: impl FnOnce(&mut GridPlacer<'_>) -> R, ) -> R

fn to_abs(&self, rect: Rect) -> Abs

Resolves a scope-local rect to absolute coordinates, unbounded ends running to the scope’s edges.

Panics

If the rect does not fit this scope.

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

Whether the cell (x, y) lies in a closed subgrid of this scope.

fn claim_functional(&mut self, rect: Rect, kind: PlacementKind) -> Region

Claims rect for a placement and mints its region.

fn region_for(&self, abs: Abs) -> Region

Mints the sections covering abs, one per row, with flat-adjacent rows merged.

fn check_coverage(&self)

Panics if any cell of this scope is still Cell::Empty.

fn assert_mapping(container: &ContainerRef, rect: Abs, mapping: &SlotMapping)

Asserts that the mapping fits the placement’s rect and the container.

Trait Implementations

impl Debug for GridPlacer<'_>

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

Formats the value using the given formatter.