Rust API

method libtmux-rs latest

Session.set_environment

Set an environment variable for processes this session starts.

Source and package

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

pub async fn set_environment( &self, name: &str, value: impl Into<OsString>, ) -> Result<(), Error> method async [source] ¶

Description#

Existing panes keep the environment they were started with; this affects what new panes inherit.

The value is marked sensitive, since an environment carries tokens.

Errors

Returns an error when tmux rejects the name or value.

Parameters

The tmux commands behind set_environment.

The C declarations in tmux that implement these commands.

Pages that discuss set_environment.

Set a variable in a session's environment

Equivalents of Set a variable in a session's environment in other languages
Language	Equivalent
Python	`libtmux.Session.set_environment`
Ruby	`LibTmux::Session#set_environment`
Lua	`libtmux.Session:set_environment`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`session.Session.setEnvironment`
Go	`tmux.Session.SetEnvironment`
Java	no equivalent on `Session`
C#	no equivalent on `Session`
C++	no equivalent on `Session`
Swift	`Server.setEnvironment(_:to:in:)`
OCaml	`Libtmux_unix.Client.set_environment`
Perl	`LibTmux::Server::set_environment` Pass an explicit session ID. Empty text and zero-like text remain values.

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