Struct Channel 

pub struct Channel<'a, 'b, T: Behavior> { /* private fields */ }

Channel associated with an SSH transport.

Implementations

impl<'a, 'b, T: Behavior> Channel<'a, 'b, T>

pub fn request(&self) -> Request<T::Command>

Returns the request associated with this channel.

pub fn user(&self) -> T::User

Returns the user associated with this channel.

pub fn client_ssh_id_string(&self) -> &str

Returns the identification string of the client.

pub async fn exit(self, exit_status: u32) -> Result<(), TransportError<T>>

Closes the channel with a given exit status.

pub async fn reader( &mut self, len: Option<usize>, ) -> Result<Reader<'a, '_, T>, TransportError<T>>

Obtains a reader over this channel.

pub async fn read_exact_stdin( &mut self, bytes: &mut [u8], ) -> Result<usize, TransportError<T>>

Convenience method for exact-or-until-EOF reads.

This method reads up to an exact number of bytes from the channel, stopping early only in the case of EOF, and returns the number of bytes that were actually read.

pub fn writer(&mut self, pipe: Pipe) -> Writer<'a, '_, T>

Obtains a writer over this channel for the specified pipe.

pub fn stdout(&mut self) -> Writer<'a, '_, T>

Obtains a writer over this channel for standard output.

pub fn stderr(&mut self) -> Writer<'a, '_, T>

Obtains a writer over this channel for standard error.

pub async fn write_all_stdout( &mut self, bytes: &[u8], ) -> Result<(), TransportError<T>>

Convenience method that writes all bytes into standard output.

pub async fn write_all_stderr( &mut self, bytes: &[u8], ) -> Result<(), TransportError<T>>

Convenience method that writes all bytes into standard error.