Rust API

session.Session.rename

Rust

Module: session
Declared in: Session
Package: libtmux
Source: crates/libtmux/src/session.rs
Other languages: Python Ruby Lua TypeScript Go Java .NET C++Swift

rename ( mut , name : impl Into<TmuxArg> ) → 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 ports Rename a session

Python libtmux.Session.rename_session
Ruby LibTmux::Session#rename
Lua libtmux.Session:rename
TypeScript session.Session.rename
Go tmux.Session.Rename
Java io.github.libtmux.Session.Session.rename
.NET LibTmux.Session.RenameAsync
C++ libtmux::Session::rename
Swift Server.rename(_:to:)

0 declared, 0 inherited