Skip to main content

PtyHandle

Struct PtyHandle 

Source
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

Source

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.
Source

pub fn write(&mut self, input: &[u8]) -> Result<()>

Write raw bytes to the PTY (reaches the child’s stdin).

Source

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:

  1. Drain everything currently in the channel (non-blocking).
  2. If nothing was found, wait up to timeout for the first chunk.
  3. After getting something (or timing out), drain any remaining buffered data.

Returns an empty Vec if no data arrived within the timeout.

Source

pub fn resize(&self, rows: u16, cols: u16) -> Result<()>

Resize the PTY to new dimensions.

Source

pub fn is_alive(&mut self) -> bool

Check whether the child process is still running.

Once the child exits, subsequent calls return false without syscalls.

Trait Implementations§

Source§

impl Drop for PtyHandle

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,