Struct SelectionState 

pub struct SelectionState { /* private fields */ }

Deterministic selection state machine.

Tracks the interactive lifecycle of a selection over the combined terminal buffer (scrollback + viewport). All methods are pure: given the same inputs, they produce the same outputs.

Implementations

impl SelectionState

pub const fn new() -> Self

Create a new state machine with no active selection.

pub fn phase(&self) -> SelectionPhase

Current phase of the selection lifecycle.

pub fn current_selection(&self) -> Option<Selection>

Returns the current selection, normalized (start ≤ end).

Returns None when phase is None.

pub fn raw_selection(&self) -> Option<Selection>

Returns the raw (non-normalized) selection for display purposes.

pub fn anchor(&self) -> Option<BufferPos>

Returns the anchor point (drag start).

pub fn granularity(&self) -> SelectionGranularity

Current selection granularity.

pub fn shape(&self) -> SelectionShape

Current selection shape.

pub fn has_selection(&self) -> bool

Whether any selection is present (selecting or active).

pub fn start(&mut self, pos: BufferPos, granularity: SelectionGranularity)

Begin a new selection at pos.

Transitions: None → Selecting, Active → Selecting. Clears any previous selection.

pub fn start_with_shape( &mut self, pos: BufferPos, granularity: SelectionGranularity, shape: SelectionShape, )

Begin a new selection with a specific shape.

pub fn drag(&mut self, pos: BufferPos)

Update the selection endpoint during drag.

Only valid when phase == Selecting. The selection is updated from anchor to pos.

pub fn drag_expanded( &mut self, pos: BufferPos, grid: &Grid, scrollback: &Scrollback, )

Update the selection with grid-aware expansion.

When granularity is Word or Line, expands the selection from the anchor word/line to the word/line containing pos.

pub fn commit(&mut self)

Commit the current selection (mouse released).

Transitions: Selecting → Active. No-op if not selecting.

pub fn cancel(&mut self)

Cancel and clear the selection.

Transitions: Any → None.

pub fn toggle_shape(&mut self)

Toggle between linear and rectangular selection.

Preserves the current selection range, only changes shape.

pub fn contains(&self, line: u32, col: u16) -> bool

Check if a cell at (line, col) is within the current selection.

Accounts for selection shape (linear vs rectangular).

pub fn extract_text( &self, grid: &Grid, scrollback: &Scrollback, ) -> Option<String>

Extract text from the current selection using the grid and scrollback.

Returns None if no selection is active. For linear selections, delegates to Selection::extract_text. For rectangular selections, delegates to Selection::extract_rect.

pub fn extract_copy( &self, grid: &Grid, scrollback: &Scrollback, opts: &CopyOptions, ) -> Option<String>

Extract text with explicit copy options.

Shape-aware: dispatches to linear or rectangular extraction based on the current selection shape.

Trait Implementations

impl Clone for SelectionState

fn clone(&self) -> SelectionState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SelectionState

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

Formats the value using the given formatter.

impl Default for SelectionState

fn default() -> Self

Returns the “default value” for a type.