pub struct PtyHandle { /* private fields */ }Expand description
Async-friendly wrapper around a PTY master/child pair.
The reader runs on a blocking Tokio thread and pushes raw byte chunks
into an unbounded mpsc channel. Consumers drain the channel via
try_read_output().
Implementations§
Source§impl PtyHandle
impl PtyHandle
Sourcepub fn spawn(
command: &str,
working_dir: Option<&str>,
env: HashMap<String, String>,
rows: u16,
cols: u16,
) -> Result<Self>
pub fn spawn( command: &str, working_dir: Option<&str>, env: HashMap<String, String>, rows: u16, cols: u16, ) -> Result<Self>
Spawn a command on a new PTY.
§Arguments
command— the program (and optional arguments) to run, e.g."bash"or"ssh user@host".working_dir— optional working directory for the child process.env— additional environment variables (merged on top of inherited env).rows/cols— initial terminal dimensions.
Sourcepub fn write(&mut self, input: &[u8]) -> Result<()>
pub fn write(&mut self, input: &[u8]) -> Result<()>
Write raw bytes to the PTY (reaches the child’s stdin).
Sourcepub async fn try_read_output(&mut self, timeout: Duration) -> Vec<u8> ⓘ
pub async fn try_read_output(&mut self, timeout: Duration) -> Vec<u8> ⓘ
Read all available output from the PTY, waiting up to timeout for data.
Behavior:
- Drain everything currently in the channel (non-blocking).
- If nothing was found, wait up to
timeoutfor the first chunk. - After getting something (or timing out), drain any remaining buffered data.
Returns an empty Vec if no data arrived within the timeout.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for PtyHandle
impl !RefUnwindSafe for PtyHandle
impl Send for PtyHandle
impl !Sync for PtyHandle
impl Unpin for PtyHandle
impl UnsafeUnpin for PtyHandle
impl !UnwindSafe for PtyHandle
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.