Session.rename/4
Renames an exact session through the selected transport; returns an action result.
Source and package
- Qualified name
-
LibTmux .Session .rename/4 - Module
- LibTmux
- Declared in
- Session
- Package
- libtmux
- Source
- lib/libtmux/entities.ex
- rename(connection, ref, name, options \\ []) @spec rename( Lib
Tmux (), Lib.Action .connection Tmux (), binary(), [Lib.Ref .t Tmux ()] ) :: {:ok, LibTmux.Action.result(:ok)} | {:error, Lib.Control .call _option Tmux ()}.Action .error -
Description#
Names contain 1..1024 UTF-8 bytes without Unicode control characters (Cc). Format syntax remains literal; tmux still normalizes names (including dollar/backslash escaping, and dots and colons on older releases). The only option is
timeout, which defaults to 5000ms. Old observations stay unchanged. SeeLibTmux.Actionfor outcome semantics.alias LibTmux.Session
Session.rename(server, session_ref, "work")
- Parameters
-
-
ref(LibTmux ()) #.Ref .t