Struct MockPtyBackend

pub struct MockPtyBackend { /* private fields */ }

Cloneable mock backend with one shared recording state.

Every clone and every session spawned from the same backend shares spawn configs, writes, resizes, and one global event queue. Session shutdown flags are per spawn, but PtyHandle clones share their session. No automatic output or exit event is generated.

Panics

Public mock operations panic with "mock pty state" if shared state’s mutex has been poisoned by another thread.

Examples

use ailloli_ui_terminal_pty::{MockPtyBackend, PtyBackend, PtySpawnConfig};
let backend = MockPtyBackend::default();
backend.spawn(PtySpawnConfig::default()).unwrap().write(b"x").unwrap();
assert_eq!(backend.writes(), vec![b"x".to_vec()]);

Implementations

impl MockPtyBackend

pub fn with_spawn_error(self, error: PtyError) -> Self

Configures a cloned error to be returned by every later spawn.

The method consumes and returns this backend value, but mutates state shared with any pre-existing clones. There is no setter to clear the error; create a fresh default backend for successful spawning. Failed configs are not added to Self::spawned_configs.

Panics

Panics if the shared mock mutex is poisoned.

Examples

use ailloli_ui_terminal_pty::{MockPtyBackend, PtyBackend, PtyError, PtySpawnConfig};
let backend = MockPtyBackend::default().with_spawn_error(PtyError::Spawn("fixture".into()));
assert_eq!(backend.spawn(PtySpawnConfig::default()).unwrap_err(), PtyError::Spawn("fixture".into()));
assert!(backend.spawned_configs().is_empty());

pub fn push_event(&self, event: PtyEvent)

Appends an event to the global queue without requiring a spawned session.

Events are stored verbatim and drained FIFO by the first session handle that calls drain_events.

Panics

Panics if the shared mock mutex is poisoned.

Examples

use ailloli_ui_terminal_pty::{MockPtyBackend, PtyBackend, PtyEvent, PtySpawnConfig};
let backend = MockPtyBackend::default(); backend.push_event(PtyEvent::Output(vec![1, 2]));
let handle = backend.spawn(PtySpawnConfig::default()).unwrap();
assert_eq!(handle.drain_events(), vec![PtyEvent::Output(vec![1, 2])]);

pub fn spawned_configs(&self) -> Vec<PtySpawnConfig>

Clones successful spawn configurations in call order.

Panics

Panics if the shared mock mutex is poisoned.

Examples

use ailloli_ui_terminal_pty::{MockPtyBackend, PtyBackend, PtySpawnConfig};
let backend = MockPtyBackend::default(); let config = PtySpawnConfig::default();
backend.spawn(config.clone()).unwrap();
assert_eq!(backend.spawned_configs(), vec![config]);

pub fn writes(&self) -> Vec<Vec<u8>>

Clones all successful writes from every shared session.

Empty writes are recorded. Mutating the returned vectors does not change the backend.

Panics

Panics if the shared mock mutex is poisoned.

Examples

use ailloli_ui_terminal_pty::{MockPtyBackend, PtyBackend, PtySpawnConfig};
let backend = MockPtyBackend::default();
backend.spawn(PtySpawnConfig::default()).unwrap().write(&[]).unwrap();
assert_eq!(backend.writes(), vec![Vec::<u8>::new()]);

pub fn resizes(&self) -> Vec<PtySize>

Clones all successful resize requests from every shared session.

Values are recorded exactly; constructor invariants are not rechecked.

Panics

Panics if the shared mock mutex is poisoned.

Examples

use ailloli_ui_terminal_pty::{MockPtyBackend, PtyBackend, PtySize, PtySpawnConfig};
let backend = MockPtyBackend::default(); let size = PtySize::new(30, 90, 0, 0);
backend.spawn(PtySpawnConfig::default()).unwrap().resize(size).unwrap();
assert_eq!(backend.resizes(), vec![size]);

Trait Implementations

impl Clone for MockPtyBackend

fn clone(&self) -> MockPtyBackend

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for MockPtyBackend

fn default() -> MockPtyBackend

Returns the “default value” for a type.

impl PtyBackend for MockPtyBackend

fn spawn(&self, config: PtySpawnConfig) -> Result<PtyHandle, PtyError>

Returns the configured error or records config and creates a fresh session.

Errors

Returns the error installed through Self::with_spawn_error, when one is configured. No session or spawn record is created in that case.

Panics

Panics if the shared mock-state mutex is poisoned.