Session.from_env
Find the session this process is running in.
Source and package
- Qualified name
-
libtmux::session:: Session:: from _env - Module
- session
- Declared in
Session- Package
- libtmux
- Source
- crates/libtmux/src/session.rs
- Other languages
- Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure
-
Description#
Resolved through the pane, because
TMUX_PANEnames exactly one pane while a server'sTMUXvalue names the session that was current when the client attached, which may since have changed.Ok(None)means tmux no longer has that pane.Errors
Returns an error when
TMUX_PANEis absent or is not a pane ID, or when the listing fails.Examples#
use libtmux::{Pane, Session};let session = server.new_session("locating-session").await?;let pane = session.panes().await?.remove(0);// Standing in for the environment tmux gives a process it starts.let found = Session::from_env_value(server, Some(pane.id().as_ref())).await?;assert_eq!(found.expect("the session exists").id(), session.id());- Parameters
-
-
server(&crate::Server ) #
-
Guides#
Pages that discuss from_env.
In other ports#
The session this process is running inside
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | session |
| Go | no equivalent on Session |
| Java | no equivalent on Session |
| C# | Lib |
| C++ | no equivalent on Session |
| Swift | no equivalent on Session |
| OCaml | No direct public OCaml equivalent is recorded for this operation. |
| Perl | No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands. |
No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.