Rust API

Up Root

method libtmux-rs latest

Session.id

Return the tmux session identity.

Source and package

Qualified name: libtmux::session::Session::id
Module: session
Declared in: Session
Package: libtmux
Source: crates/libtmux/src/session.rs
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLua TypeScript GoJavaC#C++Swift Kotlin Scala OCaml F# Clojure

#[must_use] pub const fn id(&self) -> &SessionId method [source] ¶

Description#

This is the $-prefixed id tmux assigns, which is stable across renames. It is always present.

Examples#

let guard = libtmux::test::TestServer::new().await?;
let session = guard.session("work").await?;

assert!(session.id().to_string().starts_with('$'));

guard.shutdown().await?;

In other ports#

A session's stable tmux id

Equivalents of A session's stable tmux id in other languages
Language	Equivalent
Python	`libtmux.Session.id`
Ruby	`LibTmux::SessionSnapshot#id`
Lua	`libtmux.SnapshotSession.id`
Elixir	`LibTmux.Session.id`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	no accessor; the field is read from `Session.format`, tmux's own row
Go	`tmux.Session.ID`
Java	`io.github.libtmux.Session.id`
C#	`LibTmux.Session.Id`
C++	`libtmux::Session::id`
Swift	`Session.id`
OCaml	`Libtmux.Session.id`
Perl	`LibTmux::Session::id` Schema-validated captured data; reading performs no tmux I/O.

No equivalent is recorded in PowerShell, Julia, Erlang, Common Lisp, Clojure, Kotlin, Scala or F#.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Session.id

Description#

Examples#

In other ports#

Description#

Examples#

In other ports#

Related types#