Struct ChanInOut 

pub struct ChanInOut<'g>(/* private fields */);

A bidirectional SSH channel.

Used as stdin/stdout for a shell/exec/subsystem. Represents other forwarded transports.

This must be read, otherwise the SSH session will block. If input isn’t required, use split() and discard the input half.

Clone is implemented for convenience, but only one instance each should be read from or written to (this applies to split() instances too). Otherwise ordering will be arbitrary, and if competing readers or writers are in different tasks, there will be churn as they continually wake each other up. Simultaneous single-reader and single-writer is fine.

Implementations

impl<'g> ChanInOut<'g>

pub fn num(&self) -> ChanNum

Return the channel number.

pub fn split(&self) -> (ChanIn<'g>, ChanOut<'g>)

Convert this into separate input and output.

Note the warning above against simultaneous use and Clone.

pub async fn until_closed(&self) -> Result<()>

Wait until the channel closes.

pub async fn term_window_change(&self, winch: WinChange) -> Result<()>

Send a terminal size change notification

Only applicable to client shell channels with a PTY

Trait Implementations

impl Clone for ChanInOut<'_>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'g> Debug for ChanInOut<'g>

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

Formats the value using the given formatter.

impl Drop for ChanInOut<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl ErrorType for ChanInOut<'_>

type Error = Error

Error type of all the IO operations on this type.

impl<'g> From<ChanInOut<'g>> for ChanIn<'g>

fn from(ch: ChanInOut<'g>) -> Self

Converts to this type from the input type.

impl<'g> From<ChanInOut<'g>> for ChanOut<'g>

fn from(ch: ChanInOut<'g>) -> Self

Converts to this type from the input type.

impl Read for ChanInOut<'_>

async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Read some bytes from this source into the specified buffer, returning how many bytes were read.

async fn read_exact( &mut self, buf: &mut [u8], ) -> Result<(), ReadExactError<Self::Error>>

Read the exact number of bytes required to fill buf.

impl Write for ChanInOut<'_>

async fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Write a buffer into this writer, returning how many bytes were written.

async fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

async fn write_all(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write an entire buffer into this writer.