On this page

session.settings.Session.hide_environment

Module: session.settings
Declared in: Session
Package: libtmux
Source: crates/libtmux/src/session/settings.rs

hide_environment ( self , name : &str ) → Result<(), Error> method [source] ¶ method [source] ¶ hide_environment

Hide a variable from processes started in this session.

Different from Self::unset_environment, which deletes the session's own entry and lets whatever tmux inherited show through. This keeps an entry and marks it, so a process started here is handed an environment with the name *absent* even though the tmux server has one. It is what EnvironmentEntry::Removed reports.

Errors

Returns an error when tmux rejects the name.

Examples

use libtmux::EnvironmentEntry;

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

session.hide_environment("PAGER").await?;
assert_eq!(
    session.environment_all().await?.get("PAGER"),
    Some(&EnvironmentEntry::Removed),
);

guard.shutdown().await?;

0 declared, 0 inherited