Struct TerminalConfig

pub struct TerminalConfig {
    pub size: TerminalSize,
    pub scrollback_limit: usize,
    pub security: TerminalSecurityPolicy,
}

Construction settings for TerminalState.

The size is clamped to at least one row and column by TerminalState::with_config. A zero scrollback limit is valid and discards every scrolled-off normal-screen line while still advancing its global count.

Examples

use ailloli_ui_terminal_core::{TerminalConfig, TerminalSize, TerminalState};

let state = TerminalState::with_config(TerminalConfig {
    size: TerminalSize::new(10, 40),
    scrollback_limit: 0,
    ..TerminalConfig::default()
});
assert_eq!(state.screen.size(), TerminalSize::new(10, 40));
assert_eq!(state.scrollback.limit(), 0);

Fields

size: TerminalSize

Initial rows and columns; zero dimensions are replaced with one.

scrollback_limit: usize

Maximum retained normal-screen scrollback lines.

security: TerminalSecurityPolicy

Permissions for security-sensitive terminal control sequences.

Trait Implementations

impl Clone for TerminalConfig

fn clone(&self) -> TerminalConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalConfig

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

Formats the value using the given formatter.

impl Default for TerminalConfig

fn default() -> Self

Returns a 24-by-80 terminal with 10,000 scrollback lines and secure defaults.

Examples

use ailloli_ui_terminal_core::{TerminalConfig, TerminalSize};
let config = TerminalConfig::default();
assert_eq!(config.size, TerminalSize::new(24, 80));
assert_eq!(config.scrollback_limit, 10_000);

impl<'de> Deserialize<'de> for TerminalConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TerminalConfig

fn eq(&self, other: &TerminalConfig) -> 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 TerminalConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TerminalConfig

impl Eq for TerminalConfig

impl StructuralPartialEq for TerminalConfig