Struct PtyController 

pub struct PtyController { /* private fields */ }

Available on crate features blocking or tokio only.

Cloneable control handle shared by both public front ends.

It contains no pipe or runtime-specific state. Clones may be used from any thread, and the pseudoconsole remains alive while the controller or either owned I/O half still exists.

Implementations

impl PtyController

pub fn resize(&self, size: Size) -> Result<()>

Resizes the pseudoconsole.

Errors

Returns an error with crate::ErrorKind::Resize when the session is closed or the backend rejects the requested size.

pub fn size(&self) -> Size

Returns the last successfully applied terminal size.

pub fn clear(&self) -> Result<()>

Clears the pseudoconsole screen and scrollback.

Errors

Returns an error with crate::ErrorKind::UnsupportedFeature when clearing is unavailable, or crate::ErrorKind::Clear when the operation fails.

pub fn supports_clear(&self) -> bool

Returns whether this backend provides ClearPseudoConsole.

Trait Implementations

impl Clone for PtyController

fn clone(&self) -> PtyController

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PtyController

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

Formats the value using the given formatter.