Struct TerminalWarning

pub struct TerminalWarning {
    pub kind: TerminalWarningKind,
    pub sequence: Option<String>,
    pub reason: String,
}

One recoverable terminal warning with optional source sequence.

sequence == None means no source text was retained; Some("") is a present but empty sequence. Strings are stored verbatim.

Examples

use ailloli_ui_terminal_core::{TerminalWarning, TerminalWarningKind};
let warning = TerminalWarning::new(TerminalWarningKind::InvalidUtf8, None, "invalid input");
assert_eq!(warning.sequence, None);

Fields

kind: TerminalWarningKind

Machine-readable warning category.

sequence: Option<String>

Optional offending escape/control sequence.

reason: String

Human-readable reason; may be empty.

Implementations

impl TerminalWarning

pub fn new( kind: TerminalWarningKind, sequence: Option<String>, reason: impl Into<String>, ) -> Self

Creates a warning, preserving optional sequence and reason verbatim.

Examples

use ailloli_ui_terminal_core::{TerminalWarning, TerminalWarningKind};
let warning = TerminalWarning::new(TerminalWarningKind::SizeClamped, Some("0x0".into()), "clamped");
assert_eq!(warning.kind, TerminalWarningKind::SizeClamped);

pub fn blocked_sequence( sequence: impl Into<String>, reason: impl Into<String>, ) -> Self

Creates a TerminalWarningKind::BlockedSequence warning.

The supplied sequence is always stored as Some, even when empty.

Examples

use ailloli_ui_terminal_core::{TerminalWarning, TerminalWarningKind};
let warning = TerminalWarning::blocked_sequence("OSC 52", "clipboard denied");
assert_eq!(warning.kind, TerminalWarningKind::BlockedSequence);

pub fn unsupported_sequence(sequence: impl Into<String>) -> Self

Creates an unsupported-sequence warning with a generated reason.

Examples

use ailloli_ui_terminal_core::TerminalWarning;
let warning = TerminalWarning::unsupported_sequence("CSI ? 9999 h");
assert!(warning.reason.contains("CSI ? 9999 h"));

Trait Implementations

impl Clone for TerminalWarning

fn clone(&self) -> TerminalWarning

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalWarning

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TerminalWarning

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TerminalWarning

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

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 TerminalWarning

impl StructuralPartialEq for TerminalWarning