Struct Session 

pub struct Session<S> {
    pub id: String,
    pub title: Option<String>,
    /* private fields */
}

A handle to an iTerm2 session (a single terminal pane).

Provides methods to send text, read the terminal buffer, split panes, manage variables/properties, and more.

Fields

id: String

The unique session identifier.

title: Option<String>

The session’s title, if available.

Implementations

impl<S: AsyncRead + AsyncWrite + Unpin + Send + 'static> Session<S>

pub fn new( id: String, title: Option<String>, conn: Arc<Connection<S>>, ) -> Result<Self>

Create a session handle. Validates the session ID.

pub async fn send_text(&self, text: &str) -> Result<()>

Send text to the session as if typed on the keyboard.

pub async fn get_screen_contents(&self) -> Result<Vec<String>>

Get the current visible screen contents as lines of text.

pub async fn get_buffer_lines(&self, trailing_lines: i32) -> Result<Vec<String>>

Get the last N lines from the scrollback buffer.

pub async fn split( &self, direction: SplitDirection, before: bool, profile_name: Option<&str>, ) -> Result<Vec<String>>

Split this session’s pane. Returns the new session ID(s).

pub async fn get_variable(&self, name: &str) -> Result<Option<String>>

Get a session variable by name. Returns JSON-encoded value.

pub async fn set_variable(&self, name: &str, json_value: &str) -> Result<()>

Set a session variable. Name must start with user.. Value must be valid JSON.

pub async fn get_profile_property( &self, keys: Vec<String>, ) -> Result<Vec<ProfileProperty>>

Get profile properties for this session.

pub async fn set_profile_property( &self, key: &str, json_value: &str, ) -> Result<()>

Set a profile property on this session’s copy of the profile. Value must be valid JSON.

pub async fn inject(&self, data: Vec<u8>) -> Result<()>

Inject bytes into the terminal as if produced by the running program.

pub async fn restart(&self, only_if_exited: bool) -> Result<()>

Restart the session’s shell process.

pub async fn close(&self, force: bool) -> Result<()>

Close this session. If force is true, skip the confirmation prompt.

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

Activate this session (bring its window to front and select it).

pub async fn get_prompt(&self) -> Result<GetPromptResponse>

Get metadata about the current shell prompt (command, working directory, state).

pub fn connection(&self) -> &Connection<S>

Get a reference to the underlying connection.