Struct TerminalEventRecord

Source
pub struct TerminalEventRecord {
    pub sequence: u64,
    pub kind: TerminalEventKind,
    pub payload_preview: Option<String>,
    pub redacted: bool,
    pub truncated: bool,
}
Expand description

One sanitized event-log entry.

For input/output byte events, payload_preview, redacted, and truncated describe the stored bytes. Diagnostic and command events redact only the diagnostic message or command line and expose that as the preview, but their two flags remain false even when the text policy changed or truncated the string. Warning and resize events are stored without redaction or a preview. Consumers must therefore not treat redacted == false as proof that no sanitization occurred, nor assume every nested string was scrubbed.

§Examples

use ailloli_ui_terminal_core::{TerminalEventLog, TerminalSnapshotConfig};

let mut log = TerminalEventLog::new(1);
log.record_output(b"password=abc", &TerminalSnapshotConfig::default());
let record = &log.records[0];
assert_eq!(record.sequence, 1);
assert_eq!(record.payload_preview.as_deref(), Some("password=[redacted]"));
assert!(record.redacted);

Fields§

§sequence: u64

Recording sequence; normally starts at one and saturates at u64::MAX.

§kind: TerminalEventKind

Sanitized event payload.

§payload_preview: Option<String>

Lossy byte preview or redacted message/command, depending on event kind.

§redacted: bool

Whether byte-event sanitization changed retained bytes.

This remains false for non-byte events even if text was redacted.

§truncated: bool

Whether a byte event exceeded max_event_bytes.

This remains false for non-byte events even if max_text_bytes truncated a diagnostic message or command line.

Trait Implementations§

Source§

impl Clone for TerminalEventRecord

Source§

fn clone(&self) -> TerminalEventRecord

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TerminalEventRecord

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for TerminalEventRecord

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for TerminalEventRecord

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for TerminalEventRecord

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for TerminalEventRecord

Source§

impl StructuralPartialEq for TerminalEventRecord

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,