Struct tmux_interface::commands::clients_and_sessions::attach_session::AttachSession

pub struct AttachSession<'a> {
    pub detach_other: bool,
    pub not_update_env: bool,
    pub read_only: bool,
    pub parent_sighup: bool,
    pub working_directory: Option<Cow<'a, str>>,
    pub flags: Option<ClientFlags>,
    pub target_session: Option<Cow<'a, str>>,
}

Structure for attaching client to already existing session

Manual

tmux ^3.2:

attach-session [-dErx] [-c working-directory] [-f flags] [-t target-session]
(alias: attach)

tmux ^3.0:

attach-session [-dErx] [-c working-directory] [-t target-session]
(alias: attach)

tmux ^2.1:

attach-session [-dEr] [-c working-directory] [-t target-session]
(alias: attach)

tmux ^1.9:

attach-session [-dr] [-c working-directory] [-t target-session]
(alias: attach)

tmux ^1.2:

attach-session [-dr] [-t target-session]
(alias: attach)

tmux ^0.8:

attach-session [-d] [-t target-session]
(alias: attach)

Fields

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

read_only: bool

[-r] - signifies the client is read-only

parent_sighup: bool

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

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

[-c working-directory] - specify starting directory

flags: Option<ClientFlags>

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

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

[-t target-session] - specify target session name

Implementations

impl<'a> AttachSession<'a>

pub fn new() -> Self

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 read_only(self) -> Self

[-r] - signifies the client is read-only

pub fn parent_sighup(self) -> Self

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

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

[-c working-directory] - specify starting directory

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

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

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

[-t target-session] - specify target session name

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

build command with arguments in right order

Trait Implementations

impl<'a> Clone for AttachSession<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AttachSession<'a>

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

Formats the value using the given formatter.

impl<'a> Default for AttachSession<'a>

fn default() -> AttachSession<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

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

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

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

impl<'a> StructuralPartialEq for AttachSession<'a>