Struct AsyncChannel

pub struct AsyncChannel<S> { /* private fields */ }

Implementations

impl<S> AsyncChannel<S>

where S: AsyncSessionStream + Send + Sync + 'static,

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

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

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

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

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

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

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

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

pub fn stderr(&self) -> AsyncStream<S>

pub fn stream(&self, stream_id: i32) -> AsyncStream<S>

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

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

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

pub fn read_window(&self) -> ReadWindow

pub fn write_window(&self) -> WriteWindow

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

pub fn eof(&self) -> bool

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

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

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

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

Trait Implementations

impl<S> AsyncRead for AsyncChannel<S>

where S: AsyncSessionStream + Send + Sync + 'static,

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

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<S> AsyncRead for AsyncChannel<S>

where S: AsyncSessionStream + Send + Sync + 'static,

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<(), IoError>>

Attempts to read from the AsyncRead into buf.

impl<S> AsyncWrite for AsyncChannel<S>

where S: AsyncSessionStream + Send + Sync + 'static,

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

Attempt to write bytes from buf into the object.

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

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<(), IoError>>

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.

impl<S> AsyncWrite for AsyncChannel<S>

where S: AsyncSessionStream + Send + Sync + 'static,

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

Attempt to write bytes from buf into the object.

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

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

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

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.