Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Rust API

Rust documentation

View as Markdown

Module
server
Declared in
Server
Package
libtmux
Source
crates/libtmux/src/server/settings.rs
Other languages
PythonRubyLuaTypeScriptGo Java .NET C++ Swift
environment ( self , name : &str ) → Result<Option<EnvironmentEntry>, Error>
method [source]
method [source]
environment

Read one variable from the server's environment.

tmux keeps two different things under a name: a value, and a mark saying a process started from it must not inherit the name at all. EnvironmentEntry keeps them apart, because collapsing both to absence would hide the second, which a caller sets deliberately with Self::hide_environment .

None means tmux holds nothing under the name.

Errors

Returns an error when tmux cannot be reached.

In other ports Read the server's global environment
In other ports Read one variable from the server's environment
  • Python no single-variable read; the whole table is returned
  • Ruby No source-verified Ruby equivalent is recorded for this operation.
  • Lua No source-verified Lua equivalent is recorded for this operation.
  • TypeScript server.Server.getEnvironment
  • Go tmux.Server.GetEnvironment
  • Java no single-variable read; the whole table is returned
  • .NET no single-variable read; the whole table is returned
  • C++ no single-variable read; the whole table is returned
  • Swift no single-variable read; the whole table is returned

0 declared, 0 inherited

Esc

Type to search.