libtmux Reference MCP Search
On this page

session.Session

View as Markdown

Module
session
Package
libtmux
Source
crates/libtmux/src/session.rs
struct session.Session
structoverload [source]
structoverload [source]
struct session.Session

Sessions compare by server endpoint and session id.

Equal-looking ids on different servers are different sessions, and two handles for the same session remain equal even when their snapshots were taken at different times.

35 declared, 0 inherited

Members

  • active_window method Return the session's active window.
  • attached_client_count method
  • cmd method Run a raw tmux command against this session.
  • created method
  • detach_clients method Detach every client attached to this session.
  • display method Show a message on the clients viewing this session.
  • format method Expand a tmux format string in this session's context.
  • from_env method Find the session this process is running in.
  • from_env_value method Find a session from an explicit TMUX_PANE value.
  • id method
  • is_attached method
  • kill method Kill the session.
  • last_attached method
  • last_window method Move to the window that was active before this one, and return it.
  • lock method Lock every client attached to this session.
  • name method
  • new method Build a handle from a hydrated snapshot.
  • new_window method Create a window in this session and return it.
  • next_window method Move to the next window, and return it.
  • panes method List every pane in this session, preserving any failure.
  • panes_or_empty method List every pane in this session, in tmux's own order.
  • path method
  • previous_window method Move to the previous window, and return it.
  • refresh method Replace this handle's snapshot with the session's current state.
  • refreshed method Return a new handle holding the session's current state.
  • rename method Rename the session and update this handle.
  • search_windows method
  • search_windows_or_empty method
  • server_identity method
  • window method Find this session's window with the given name.
  • window_at method Find this session's window at the given index.
  • window_count method
  • windows method List the windows linked into this session, preserving any failure.
  • windows_or_empty method List the windows linked into this session, in tmux's own order.
  • with_window method Create a window, run an operation with it, then kill it.
Esc

Type to search.