Struct Channel

pub struct Channel { /* private fields */ }

See Channel.

Implementations

impl Channel

pub async fn setenv(&mut self, var: &str, val: &str) -> Result<(), Error>

See setenv.

pub async fn request_pty( &mut self, term: &str, mode: Option<PtyModes>, dim: Option<(u32, u32, u32, u32)>, ) -> Result<(), Error>

See request_pty.

pub async fn request_pty_size( &mut self, width: u32, height: u32, width_px: Option<u32>, height_px: Option<u32>, ) -> Result<(), Error>

See request_pty_size.

pub async fn exec(&mut self, command: &str) -> Result<(), Error>

See exec.

pub async fn shell(&mut self) -> Result<(), Error>

See shell.

pub async fn subsystem(&mut self, system: &str) -> Result<(), Error>

See subsystem.

pub async fn process_startup( &mut self, request: &str, message: Option<&str>, ) -> Result<(), Error>

See process_startup.

pub fn stderr(&mut self) -> Stream

See stderr.

pub fn stream(&mut self, stream_id: i32) -> Stream

See stream.

pub async fn handle_extended_data( &mut self, mode: ExtendedData, ) -> Result<(), Error>

See handle_extended_data.

pub fn exit_status(&self) -> Result<i32, Error>

See exit_status.

pub fn exit_signal(&self) -> Result<ExitSignal, Error>

See exit_signal.

pub fn read_window(&self) -> ReadWindow

See read_window.

pub fn write_window(&self) -> WriteWindow

See write_window.

pub async fn adjust_receive_window( &mut self, adjust: u64, force: bool, ) -> Result<u64, Error>

See adjust_receive_window.

pub fn eof(&self) -> bool

See eof.

pub async fn send_eof(&mut self) -> Result<(), Error>

See send_eof.

pub async fn wait_eof(&mut self) -> Result<(), Error>

See wait_eof.

pub async fn close(&mut self) -> Result<(), Error>

See close.

pub async fn wait_close(&mut self) -> Result<(), Error>

See wait_close.

Trait Implementations

impl AsyncRead for Channel

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncWrite for Channel

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.