Struct thrussh::client::Channel

pub struct Channel { /* fields omitted */ }

Implementations

impl Channel

pub async fn wait<'_>(&'_ mut self) -> Option<ChannelMsg>

Wait for data to come.

Methods from Deref<Target = ChannelSender>

pub fn id(&self) -> ChannelId

pub async fn request_pty<'_, '_, '_>(
    &'_ mut self,
    want_reply: bool,
    term: &'_ str,
    col_width: u32,
    row_height: u32,
    pix_width: u32,
    pix_height: u32,
    terminal_modes: &'_ [(Pty, u32)]
) -> Result<(), Error>

Request a pseudo-terminal with the given characteristics.

pub async fn request_shell<'_>(
    &'_ mut self,
    want_reply: bool
) -> Result<(), Error>

Request a remote shell.

pub async fn exec<'_, A: Into<String>>(
    &'_ mut self,
    want_reply: bool,
    command: A
) -> Result<(), Error>

Execute a remote program (will be passed to a shell). This can be used to implement scp (by calling a remote scp and tunneling to its standard input).

pub async fn signal<'_>(&'_ mut self, signal: Sig) -> Result<(), Error>

Signal a remote process.

pub async fn request_subsystem<'_, A: Into<String>>(
    &'_ mut self,
    want_reply: bool,
    name: A
) -> Result<(), Error>

Request the start of a subsystem with the given name.

pub async fn tcpip_forward<'_, A: Into<String>>(
    &'_ mut self,
    want_reply: bool,
    address: A,
    port: u32
) -> Result<(), Error>

Request the forwarding of a remote port to the client. The server will then open forwarding channels (which cause the client to call .channel_open_forwarded_tcpip()).

pub async fn cancel_tcpip_forward<'_, A: Into<String>>(
    &'_ mut self,
    want_reply: bool,
    address: A,
    port: u32
) -> Result<(), Error>

Cancel a previous forwarding request.

pub async fn request_x11<'_, A: Into<String>, B: Into<String>>(
    &'_ mut self,
    want_reply: bool,
    single_connection: bool,
    x11_authentication_protocol: A,
    x11_authentication_cookie: B,
    x11_screen_number: u32
) -> Result<(), Error>

Request X11 forwarding through an already opened X11 channel. See RFC4254 for security issues related to cookies.

pub async fn set_env<'_, A: Into<String>, B: Into<String>>(
    &'_ mut self,
    want_reply: bool,
    variable_name: A,
    variable_value: B
) -> Result<(), Error>

Set a remote environment variable.

pub async fn window_change<'_>(
    &'_ mut self,
    col_width: u32,
    row_height: u32,
    pix_width: u32,
    pix_height: u32
) -> Result<(), Error>

Inform the server that our window size has changed.

pub async fn data<'_, B: AsRef<[u8]>>(
    &'_ mut self,
    data: B
) -> Result<(), Error>

Send data to a channel. The number of bytes added to the "sending pipeline" (to be processed by the event loop) is returned.

pub async fn extended_data<'_, '_>(
    &'_ mut self,
    ext: u32,
    data: &'_ [u8]
) -> Result<(), Error>

Send data to a channel. The number of bytes added to the "sending pipeline" (to be processed by the event loop) is returned.

pub async fn eof<'_>(&'_ mut self) -> Result<(), Error>

Trait Implementations

impl Deref for Channel

type Target = ChannelSender

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Channel

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.