Struct TerminalDamage

pub struct TerminalDamage {
    pub full: bool,
    pub dirty_lines: Vec<usize>,
    pub cursor_dirty: bool,
    pub title_dirty: bool,
}

Accumulated terminal regions and presentation properties requiring redraw.

Line indices are zero-based, unique, and sorted when added through methods; public mutation or deserialization can bypass those invariants. No row bound is stored or checked.

Examples

use ailloli_ui_terminal_core::TerminalDamage;
let mut damage = TerminalDamage::clean();
damage.mark_line(3);
assert_eq!(damage.dirty_lines, vec![3]);

Fields

full: bool

true requests repaint of the complete grid.

dirty_lines: Vec<usize>

Sorted unique zero-based rows dirtied through the API.

cursor_dirty: bool

true requests cursor repaint.

title_dirty: bool

true requests title refresh.

Implementations

impl TerminalDamage

pub fn clean() -> Self

Creates a snapshot with no pending grid, cursor, or title damage.

Examples

use ailloli_ui_terminal_core::TerminalDamage;
let damage = TerminalDamage::clean();
assert!(!damage.full && damage.dirty_lines.is_empty());

pub fn full() -> Self

Creates a full-grid snapshot with cursor and title both dirty.

Examples

use ailloli_ui_terminal_core::TerminalDamage;
let damage = TerminalDamage::full();
assert!(damage.full && damage.cursor_dirty && damage.title_dirty);

pub fn mark_full(&mut self)

Requests full-grid and cursor repaint and clears individual rows.

The existing title_dirty value is preserved.

Examples

use ailloli_ui_terminal_core::TerminalDamage;
let mut damage = TerminalDamage::clean();
damage.mark_line(2);
damage.mark_full();
assert!(damage.full && damage.cursor_dirty && damage.dirty_lines.is_empty());

pub fn mark_line(&mut self, line: usize)

Adds one zero-based line index, maintaining sorted uniqueness.

Values outside the actual terminal height are accepted.

Examples

use ailloli_ui_terminal_core::TerminalDamage;
let mut damage = TerminalDamage::clean();
damage.mark_line(4); damage.mark_line(1); damage.mark_line(4);
assert_eq!(damage.dirty_lines, vec![1, 4]);

pub fn mark_range(&mut self, start: usize, end_inclusive: usize)

Adds every line in an inclusive range.

start > end_inclusive is an empty no-op. Work and storage are linear in the range length, and indices are not bounded to a screen height.

Examples

use ailloli_ui_terminal_core::TerminalDamage;
let mut damage = TerminalDamage::clean();
damage.mark_range(2, 4);
assert_eq!(damage.dirty_lines, vec![2, 3, 4]);

pub fn mark_cursor(&mut self)

Requests a cursor repaint.

Examples

use ailloli_ui_terminal_core::TerminalDamage;
let mut damage = TerminalDamage::clean(); damage.mark_cursor();
assert!(damage.cursor_dirty);

pub fn mark_title(&mut self)

Requests a title refresh.

Examples

use ailloli_ui_terminal_core::TerminalDamage;
let mut damage = TerminalDamage::clean(); damage.mark_title();
assert!(damage.title_dirty);

pub fn reset(&mut self)

Discards every pending damage flag and dirty row.

Examples

use ailloli_ui_terminal_core::TerminalDamage;
let mut damage = TerminalDamage::full(); damage.reset();
assert_eq!(damage, TerminalDamage::clean());

Trait Implementations

impl Clone for TerminalDamage

fn clone(&self) -> TerminalDamage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalDamage

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

Formats the value using the given formatter.

impl Default for TerminalDamage

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TerminalDamage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TerminalDamage

fn eq(&self, other: &TerminalDamage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TerminalDamage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TerminalDamage

impl StructuralPartialEq for TerminalDamage