Skip to main content

PtyIo

Struct PtyIo 

Source
pub struct PtyIo {
    pub input: InputPolicy,
    pub output: OutputPolicy,
    pub observer: OutputObserver,
    pub size: PtySize,
}
Expand description

Pseudoterminal-backed I/O mode.

The child runs attached to a real controlling terminal, so it renders output exactly as it would in an interactive shell — colors, progress bars, and tty-gated formatting are preserved. Unlike the pipe-backed modes, a PTY has a single stream: the child’s stdout and stderr are merged in emission order.

The merged stream is delivered through the observer’s stdout callbacks and, when the output policy captures either stdout or stderr, retained as the result’s stdout (the two streams are merged, so either capture flag opts into keeping the combined output). The child never writes to the result’s stderr in this mode; the only bytes that can appear there are synthetic termination diagnostics injected by the lifecycle layer (for example a note that the child was killed after a timeout or cancellation).

Fields§

§input: InputPolicy

Standard input policy. Only InputPolicy::Closed and InputPolicy::Bytes are supported; inherited stdin is rejected.

Terminal stdin cannot be half-closed, so InputPolicy::Closed does not deliver a pipe-style EOF here: it simply means no bytes are ever written to the child’s terminal (the child keeps reading from a live tty that stays open until the PTY is torn down), not that the child sees stdin closed. Likewise InputPolicy::Bytes are delivered as terminal input (as if typed) through the PTY’s line discipline, so a reader returns on a newline rather than on the writer closing.

§output: OutputPolicy

Capture policy for the merged output stream. Either capture_stdout or capture_stderr retains the combined stream (surfaced as the result’s stdout); max_output_bytes bounds it.

§observer: OutputObserver

Observer callbacks for the merged output stream (delivered via stdout).

§size: PtySize

Window size advertised to the child through the PTY.

Implementations§

Source§

impl PtyIo

Source

pub fn new(observer: OutputObserver) -> Self

Create a PTY mode that observes the merged stream through observer.

Source

pub fn with_input(self, input: InputPolicy) -> Self

Set the stdin policy.

Source

pub fn with_output(self, output: OutputPolicy) -> Self

Set the capture policy for the merged output stream.

Source

pub fn with_size(self, size: PtySize) -> Self

Set the window size advertised to the child.

Trait Implementations§

Source§

impl Clone for PtyIo

Source§

fn clone(&self) -> PtyIo

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PtyIo

Source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for PtyIo

Source§

fn default() -> PtyIo

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for PtyIo

§

impl !UnwindSafe for PtyIo

§

impl Freeze for PtyIo

§

impl Send for PtyIo

§

impl Sync for PtyIo

§

impl Unpin for PtyIo

§

impl UnsafeUnpin for PtyIo

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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