libtmux Reference MCP Search
On this page

session.Session.rename

View as Markdown

Module
session
Declared in
Session
Package
libtmux
Source
crates/libtmux/src/session.rs
Other languages
PythonTypeScriptGoJava.NETC++Swift
rename ( mut , name : impl Into<OsString> ) Result<&mut Self, Error>
method [source]
method [source]
rename

Rename the session and update this handle.

Errors

Returns an error when tmux refuses the name, which includes one that is empty or already taken. tmux expands the name as a format before it checks it, so #(command) in one runs a shell command. See [the crate documentation][crate#a-name-reaches-tmux-as-a-format] before passing text a caller supplied.

In other languages Rename a session

0 declared, 0 inherited

Esc

Type to search.