Struct PtyOutputBatcher

pub struct PtyOutputBatcher { /* private fields */ }

Single-threaded accumulator producing ordered PtyEvent::Output batches.

The batcher owns raw bytes and performs no decoding, parsing, redaction, or I/O. It records wall-clock instants internally, so timeout tests/callers must drive Self::tick using the real monotonic clock.

Examples

use ailloli_ui_terminal_pty::{PtyEvent, PtyOutputBatcher};
let mut batcher = PtyOutputBatcher::new();
assert!(batcher.push(b"partial").is_empty());
assert_eq!(batcher.flush(), Some(PtyEvent::Output(b"partial".to_vec())));

Implementations

impl PtyOutputBatcher

pub fn new() -> Self

Creates an empty batcher with PtyBatchConfig::default.

Examples

use ailloli_ui_terminal_pty::PtyOutputBatcher;
let mut batcher = PtyOutputBatcher::new();
assert_eq!(batcher.flush(), None);

pub fn with_config(config: PtyBatchConfig) -> Self

Creates an empty batcher, clamping max_bytes to at least one.

The timeout is retained exactly, including zero. The normalized config is private; behavior rather than configuration introspection exposes it.

Examples

use ailloli_ui_terminal_pty::{PtyBatchConfig, PtyEvent, PtyOutputBatcher};
let mut batcher = PtyOutputBatcher::with_config(PtyBatchConfig {
    max_bytes: 0,
    flush_timeout: std::time::Duration::ZERO,
});
assert_eq!(batcher.push(b"x"), vec![PtyEvent::Output(b"x".to_vec())]);

pub fn push(&mut self, bytes: &[u8]) -> Vec<PtyEvent>

Appends a raw chunk and returns zero or one flushed output event.

An empty slice is a complete no-op and does not reset the inactivity timer. A non-empty slice flushes the entire pending buffer when its final length reaches the byte trigger or the new slice contains any newline. Bytes after that newline remain in the same event; input is never split. Otherwise the timer is reset to now and an empty vector is returned.

Panics

Growing the pending buffer can panic or abort if allocation fails.

Examples

use ailloli_ui_terminal_pty::{PtyEvent, PtyOutputBatcher};
let mut batcher = PtyOutputBatcher::new();
assert!(batcher.push(b"a").is_empty());
assert_eq!(batcher.push(b"b\nc"), vec![PtyEvent::Output(b"ab\nc".to_vec())]);

pub fn tick(&mut self) -> Option<PtyEvent>

Flushes pending bytes once the configured inactivity timeout has elapsed.

Returns None when empty or still inside the timeout. A successful flush resets the internal timer.

Examples

use std::time::Duration;
use ailloli_ui_terminal_pty::{PtyBatchConfig, PtyEvent, PtyOutputBatcher};
let mut batcher = PtyOutputBatcher::with_config(PtyBatchConfig {
    max_bytes: 10,
    flush_timeout: Duration::ZERO,
});
assert!(batcher.push(b"x").is_empty());
assert_eq!(batcher.tick(), Some(PtyEvent::Output(b"x".to_vec())));

pub fn flush(&mut self) -> Option<PtyEvent>

Immediately moves all pending bytes into one output event.

Returns None when empty. The replacement pending vector has no promised retained capacity, and the inactivity timestamp is cleared.

Examples

use ailloli_ui_terminal_pty::{PtyEvent, PtyOutputBatcher};
let mut batcher = PtyOutputBatcher::new(); batcher.push(b"raw");
assert_eq!(batcher.flush(), Some(PtyEvent::Output(b"raw".to_vec())));
assert_eq!(batcher.flush(), None);

Trait Implementations

impl Debug for PtyOutputBatcher

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

Formats the value using the given formatter.

impl Default for PtyOutputBatcher

fn default() -> Self

Creates the same empty batcher as Self::new.

Examples

use ailloli_ui_terminal_pty::PtyOutputBatcher;
assert_eq!(PtyOutputBatcher::default().flush(), None);