Skip to main content

TerminalSession

Struct TerminalSession 

Source
pub struct TerminalSession { /* private fields */ }
Expand description

A pseudoterminal that stays open until the caller closes it, so input may be sent long after the process started.

Implementations§

Source§

impl TerminalSession

Source

pub fn output(&self) -> &str

Raw PTY output seen so far.

Source

pub fn frames(&self) -> &[TerminalFrame]

Settled states retained so far.

Source

pub fn transcript(&self) -> String

Unrolled transcript of the states retained so far.

Source

pub fn running(&self) -> bool

Whether the child is still alive.

Source

pub fn wait_for( &mut self, pattern: &TerminalPattern, idle: Duration, timeout: Option<Duration>, ) -> Result<(), TerminalCaptureError>

Block until pattern has been seen and, when idle is non-zero, no further output arrived for that long. New output restarts the idle wait.

Source

pub fn send( &mut self, interaction: &TerminalInteraction, ) -> Result<(), TerminalCaptureError>

Send text, a named key, or a resize to the live terminal, using the same vocabulary as TerminalInteraction.

Source

pub fn finish(self) -> Result<TerminalCapture, TerminalCaptureError>

Wait for a child that exits on its own, then produce the capture.

Source

pub fn close(self) -> Result<TerminalCapture, TerminalCaptureError>

Stop the child if it is still running, then produce the capture and write any configured artifacts.

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.