pub struct InteractivePtySession { /* private fields */ }Expand description
Canonical interactive PTY recipe for downstream Rust consumers.
NativePtyProcess remains the low-level primitive. This wrapper owns the
interactive setup that callers commonly forget to assemble correctly.
Implementations§
Source§impl InteractivePtySession
impl InteractivePtySession
pub fn new(process: NativePtyProcess) -> Self
pub fn with_options( process: NativePtyProcess, options: InteractivePtyOptions, ) -> Self
pub fn process(&self) -> &NativePtyProcess
pub fn start(&self) -> Result<(), PtyError>
pub fn pump_output( &self, timeout: Option<f64>, consume_all: bool, ) -> Result<InteractivePtyPumpResult, PtyError>
pub fn resize(&self, rows: u16, cols: u16) -> Result<(), PtyError>
pub fn send_interrupt(&self) -> Result<(), PtyError>
pub fn wait(&self, timeout: Option<f64>) -> Result<i32, PtyError>
pub fn wait_and_drain( &self, timeout: Option<f64>, drain_timeout: f64, ) -> Result<i32, PtyError>
pub fn terminate(&self) -> Result<(), PtyError>
pub fn kill(&self) -> Result<(), PtyError>
pub fn close(&self) -> Result<(), PtyError>
Auto Trait Implementations§
impl !Freeze for InteractivePtySession
impl RefUnwindSafe for InteractivePtySession
impl Send for InteractivePtySession
impl Sync for InteractivePtySession
impl Unpin for InteractivePtySession
impl UnsafeUnpin for InteractivePtySession
impl UnwindSafe for InteractivePtySession
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.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more