Struct Session 

pub struct Session { /* private fields */ }

An SSH session handle that provides methods for executing commands, transferring files, and managing interactive shells.

Use Session::init to create a new session builder.

Implementations

impl<'sb> Session

pub fn init() -> SessionBuilder<'sb>

Creates a new session builder with default settings.

Defaults:

• Host: localhost
• User: root
• Port: 22
• Command: bash
• Inactivity timeout: 3000 seconds

Example

use simple_ssh::Session;

let session = Session::init()
    .with_host("example.com")
    .with_user("admin")
    .with_passwd("secret")
    .build();

pub async fn connect(self) -> Result<Self>

Connects to the SSH server using the configured authentication method.

Errors

Returns an error if:

• The hostname cannot be resolved
• The connection fails
• Authentication fails

pub async fn pty(&mut self) -> Result<u32>

Opens an interactive PTY (pseudo-terminal) session.

This is useful for interactive shell sessions where you want terminal emulation support.

Returns

The exit code of the shell session.

Errors

Returns an error if no connection is established.

pub fn pty_builder(&mut self) -> PtyBuilder<'_>

Creates a PTY builder for advanced terminal configuration.

The builder provides options for raw mode, terminal type, dimensions, and custom commands.

Example

let exit_code = session.pty_builder()
    .with_raw()
    .with_term("xterm-256color")
    .run().await?;

pub async fn run(&mut self) -> Result<u32>

Runs the configured command with output to stdout and stderr.

Uses the command specified via SessionBuilder::with_cmd.

Returns

The exit code of the command.

Errors

Returns an error if no connection is established.

pub async fn exec(&mut self, command: &Vec<String>) -> Result<u32>

Executes a command with the given arguments.

Arguments

• command - A vector of command and its arguments

Returns

The exit code of the command.

Errors

Returns an error if no connection is established.

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

Executes a shell command via sh -c.

Arguments

• command - The shell command to execute

Returns

The exit code of the command.

Errors

Returns an error if no connection is established.

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

Executes a single command string.

Arguments

• command - The command to execute

Returns

The exit code of the command.

Errors

Returns an error if no connection is established.

pub async fn scp(&mut self, from: &str, to: &str) -> Result<()>

Transfers a file to the remote host via SCP.

Arguments

• from - Local file path
• to - Remote destination path

Errors

Returns an error if:

• No connection is established
• The local file cannot be read
• The transfer fails

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

Closes the SSH session gracefully.

Errors

Returns an error if the disconnect message fails to send.