Struct tmux_interface::commands::global_and_session_environment::set_environment::SetEnvironment

pub struct SetEnvironment<'a> {
    pub expand: bool,
    pub hidden: bool,
    pub global: bool,
    pub remove: bool,
    pub unset: bool,
    pub target_session: Option<Cow<'a, str>>,
    pub name: Option<Cow<'a, str>>,
    pub value: Option<Cow<'a, str>>,
}

Structure for setting or unsetting an environment variable

Manual

tmux ^3.2:

set-environment [-Fhgru] [-t target-session] name [value]
(alias: setenv)

tmux ^1.0:

set-environment [-gru] [-t target-session] name [value]
(alias: setenv)

Fields

expand: bool

[-F] - value is expanded as a format

hidden: bool

[-h] - marks the variable as hidden

global: bool

[-g] - make change in the global environment

remove: bool

[-r] - remove the variable from the environment before starting a new process

unset: bool

[-u] - unset a variable

target_session: Option<Cow<'a, str>>

[-t target-session] - target-session

name: Option<Cow<'a, str>>

name

value: Option<Cow<'a, str>>

[value] - specify the value

Implementations

impl<'a> SetEnvironment<'a>

pub fn new() -> Self

pub fn expand(self) -> Self

[-F] - value is expanded as a format

pub fn hidden(self) -> Self

[-h] - marks the variable as hidden

pub fn global(self) -> Self

[-g] - make change in the global environment

pub fn remove(self) -> Self

[-r] - remove the variable from the environment before starting a new process

pub fn unset(self) -> Self

[-u] - unset a variable

pub fn target_session<S: Into<Cow<'a, str>>>(self, target_session: S) -> Self

[-t target-session] - target-session

pub fn name<S: Into<Cow<'a, str>>>(self, name: S) -> Self

name

pub fn value<S: Into<Cow<'a, str>>>(self, value: S) -> Self

[value] - specify the value

pub fn build(self) -> TmuxCommand<'a>

Trait Implementations

impl<'a> Clone for SetEnvironment<'a>

fn clone(&self) -> SetEnvironment<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for SetEnvironment<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for SetEnvironment<'a>

fn default() -> SetEnvironment<'a>

Returns the “default value” for a type.

impl<'a> From<SetEnvironment<'a>> for TmuxCommand<'a>

fn from(item: SetEnvironment<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for SetEnvironment<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for SetEnvironment<'a>

fn cmp(&self, other: &SetEnvironment<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'a> PartialEq for SetEnvironment<'a>

fn eq(&self, other: &SetEnvironment<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for SetEnvironment<'a>

fn partial_cmp(&self, other: &SetEnvironment<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for SetEnvironment<'a>

impl<'a> StructuralPartialEq for SetEnvironment<'a>