Struct tmux_interface::commands::clients_and_sessions::new_session::NewSession

pub struct NewSession<'a> {

    pub attach: bool,
    pub detached: bool,
    pub detach_other: bool,
    pub not_update_env: bool,
    pub print: bool,
    pub parent_sighup: bool,
    pub start_directory: Option<Cow<'a, str>>,
    pub environment: Option<Vec<(Cow<'a, str>, Cow<'a, str>)>>,
    pub flags: Option<ClientFlags>,
    pub format: Option<Cow<'a, str>>,
    pub window_name: Option<Cow<'a, str>>,
    pub session_name: Option<Cow<'a, str>>,
    pub group_name: Option<Cow<'a, str>>,
    pub width: Option<usize>,
    pub height: Option<usize>,
    pub shell_command: Option<Cow<'a, str>>,
}

Structure for creating a new session

Manual

tmux 3.2:

new-session [-AdDEPX] [-c start-directory] [-e environment] [-f flags] [-F format]
[-n window-name] [-s session-name] [-t group-name] [-x width] [-y height] [shell-command]
(alias: new)

tmux 3.0:

new-session [-AdDEPX] [-c start-directory] [-F format] [-n window-name] [-s session-name]
[-t group-name] [-x width] [-y height] [shell-command]
(alias: new)

tmux 2.4:

new-session [-AdDEP] [-c start-directory] [-F format] [-n window-name] [-s session-name]
[-t group-name] [-x width] [-y height] [shell-command]
(alias: new)

tmux 2.1:

new-session [-AdDEP] [-c start-directory] [-F format] [-n window-name] [-s session-name]
[-t target-session] [-x width] [-y height] [shell-command]
(alias: new)

tmux 1.9:

new-session [-AdDP] [-c start-directory] [-F format] [-n window-name] [-s session-name]
[-t target-session] [-x width] [-y height] [shell-command]
(alias: new)

tmux 1.8:

new-session [-AdDP] [-F format] [-n window-name] [-s session-name] [-t target-session]
[-x width] [-y height] [shell-command]
(alias: new)

tmux 1.6:

new-session [-d] [-n window-name] [-s session-name] [-t target-session] [-x width]
[-y height] [shell-command]
(alias: new)

tmux 1.2:

new-session [-d] [-n window-name] [-s session-name] [-t target-session] [shell-command]
(alias: new)

tmux 1.1:

new-session [-d] [-n window-name] [-s session-name] [-t target-session] [command]
(alias: new)

tmux ^0.8:

new-session [-d] [-n window-name] [-s session-name] [command]
(alias: new)

Fields

attach: bool

[-A] - behave like attach-session if session-name already exists

detached: bool

[-d] - new session is not attached to the current terminal

detach_other: bool

[-D] - any other clients attached to the session are detached

not_update_env: bool

[-E] - update-environment option will not be applied

print: bool

[-P] - print information about the new session after it has been created

parent_sighup: bool

[-X] - send SIGHUP to the parent process, detaching the client

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

[-c start-directory] - specify starting directory

environment: Option<Vec<(Cow<'a, str>, Cow<'a, str>)>>

[-e environment] - takes the form ‘VARIABLE=value’ and sets an environment variable for the newly created session; it may be specified multiple times

flags: Option<ClientFlags>

[-f flags] - comma-separated list of client flags

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

[-F format] - specify different format

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

[-n window-name] - window name of the initial window

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

[-s session-name] - specify a session name

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

[-t group-name] - specify a session group

width: Option<usize>

[-x width] - specify a different width

height: Option<usize>

[-y height] - specify a different height

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

[shell-command] - shell command to execute in the initial window

Implementations

impl<'a> NewSession<'a>

pub fn new() -> Self

pub fn attach(self) -> Self

[-A] - behave like attach-session if session-name already exists

pub fn detached(self) -> Self

[-d] - new session is not attached to the current terminal

pub fn detach_other(self) -> Self

[-D] - any other clients attached to the session are detached

pub fn not_update_env(self) -> Self

[-E] - update-environment option will not be applied

pub fn print(self) -> Self

[-P] - print information about the new session after it has been created

pub fn parent_sighup(self) -> Self

[-X] - send SIGHUP to the parent process, detaching the client

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

[-c start-directory] - specify starting directory

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

[-e start-directory] - takes the form ‘VARIABLE=value’ and sets an environment variable for the newly created session; it may be specified multiple times.

pub fn flags(self, flags: ClientFlags) -> Self

[-f flags] - sets a comma-separated list of client flags

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

[-F format] - specify different format

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

[-n window-name] - window name of the initial window

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

[-s session-name] - specify a session name

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

[-t group-name] - specify a session group

pub fn width(self, width: usize) -> Self

[-x width] - specify a different width

pub fn height(self, height: usize) -> Self

[-y height] - specify a different height

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

[shell-command] - shell command to execute in the initial window

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

Trait Implementations

impl<'a> Clone for NewSession<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for NewSession<'a>

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

Formats the value using the given formatter.

impl<'a> Default for NewSession<'a>

fn default() -> NewSession<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl<'a> Hash for NewSession<'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 NewSession<'a>

fn cmp(&self, other: &NewSession<'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 NewSession<'a>

fn eq(&self, other: &NewSession<'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 NewSession<'a>

fn partial_cmp(&self, other: &NewSession<'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 NewSession<'a>

impl<'a> StructuralPartialEq for NewSession<'a>