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
impl TerminalSession
Sourcepub fn frames(&self) -> &[TerminalFrame]
pub fn frames(&self) -> &[TerminalFrame]
Settled states retained so far.
Sourcepub fn transcript(&self) -> String
pub fn transcript(&self) -> String
Unrolled transcript of the states retained so far.
Sourcepub fn wait_for(
&mut self,
pattern: &TerminalPattern,
idle: Duration,
timeout: Option<Duration>,
) -> Result<(), TerminalCaptureError>
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.
Sourcepub fn send(
&mut self,
interaction: &TerminalInteraction,
) -> Result<(), TerminalCaptureError>
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.
Sourcepub fn finish(self) -> Result<TerminalCapture, TerminalCaptureError>
pub fn finish(self) -> Result<TerminalCapture, TerminalCaptureError>
Wait for a child that exits on its own, then produce the capture.
Sourcepub fn close(self) -> Result<TerminalCapture, TerminalCaptureError>
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§
impl !RefUnwindSafe for TerminalSession
impl !Sync for TerminalSession
impl !UnwindSafe for TerminalSession
impl Freeze for TerminalSession
impl Send for TerminalSession
impl Unpin for TerminalSession
impl UnsafeUnpin for TerminalSession
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
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>
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)
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)
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.