Struct Session 

pub struct Session { /* private fields */ }

An authenticated SSH connection to a device.

Session is Clone + Send + Sync — cloning is cheap (increments a reference count). Use open_channel() to create independent PTY shells on the same underlying SSH connection.

Obtain a Session via SessionBuilder::connect() or GenericDriver::session().

Implementations

impl Session

pub async fn open_channel(&self) -> Result<Channel>

Open a new PTY channel on this session.

Each channel gets its own interactive shell, privilege state, and pattern buffer. The channel waits for the initial prompt, executes on_open_commands, and determines the initial privilege level before returning.

pub fn is_alive(&self) -> bool

Check if the underlying SSH transport is still alive.

pub fn platform(&self) -> &PlatformDefinition

Get the platform definition.

pub fn connected_since(&self) -> Instant

When this session was established.

pub fn prompt_patterns(&self) -> &[Regex]

Get the prompt patterns.

pub async fn disconnected(&self) -> DisconnectReason

Wait until the session disconnects and return the reason.

If already disconnected, returns immediately. If the watch channel is dropped without a reason, returns DisconnectReason::Closed.

Session is Clone (Arc-based), so callers can clone and move into a tokio::spawn or tokio::select! branch.

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

Close the SSH connection.

Signals disconnect to all channels, then closes the transport. Since Session is Clone, this can be called from any clone — all clones share the same underlying connection.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.