Terminal

Struct Terminal 

Source
pub struct Terminal {
    input_tx: Sender<Vec<u8>>,
    output_tx: Sender<Vec<u8>>,
    fd: Arc<AsyncFd<OwnedFd>>,
    child: Mutex<Option<Child>>,
    closed_rx: Receiver<bool>,
}
Expand description

Async terminal backed by a real PTY.

Spawns two background tasks (read loop and write loop) that bridge the PTY fd with tokio channels. Sends SIGHUP to the child process on drop.

Fields§

§input_tx: Sender<Vec<u8>>§output_tx: Sender<Vec<u8>>§fd: Arc<AsyncFd<OwnedFd>>§child: Mutex<Option<Child>>§closed_rx: Receiver<bool>

Implementations§

Source§

impl Terminal

Source

pub fn spawn( shell: &str, pwd: Option<&Path>, ) -> Result<(Self, Receiver<Vec<u8>>)>

Spawn a shell process and return the terminal plus an initial output receiver.

If pwd is provided, the shell starts in that directory.

Source

pub fn subscribe(&self) -> Receiver<Vec<u8>>

Subscribe to the terminal output broadcast channel.

Source

pub fn closed(&self) -> Receiver<bool>

Returns a watch receiver that becomes true when the PTY read loop exits (shell died / PTY closed).

Source

pub async fn write(&self, data: Vec<u8>) -> Result<(), String>

Queue bytes to be written to the PTY.

Source

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

Set the PTY window size (rows x cols).

Trait Implementations§

Source§

impl Drop for Terminal

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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