Struct tmux_interface::commands::clients_and_sessions::refresh_client::RefreshClient

pub struct RefreshClient<'a> {

    pub tracking_cursor: bool,
    pub down: bool,
    pub request_clipboard: bool,
    pub left: bool,
    pub right: bool,
    pub status_line: bool,
    pub up: bool,
    pub allow_actions: Option<AllowActions<'a>>,
    pub subscribe: Option<Subscribe<'a>>,
    pub size: Option<(usize, usize)>,
    pub flags: Option<ClientFlags>,
    pub target_client: Option<Cow<'a, str>>,
    pub adjustment: Option<usize>,
}

Structure for refreshing the current client

Manual

tmux 3.3:

refresh-client [-cDLRSU] [-A pane:state] [-B name:what:format] [-C XxY] [-f flags]
[-l [target-pane]] [-t target-client] [adjustment] (alias: refresh)

tmux 3.2:

refresh-client [-cDlLRSU] [-A pane:state] [-B name:what:format] [-C XxY] [-f flags] [-t target-client] [adjustment]
(alias: refresh)

tmux 3.0:

refresh-client [-cDlLRSU] [-C XxY] [-F flags] [-t target-client] [adjustment]
(alias: refresh)

tmux 2.9a:

refresh-client [-cDlLRSU] [-C width,height] [-F flags] [-t target-client] [adjustment]
(alias: refresh)

tmux 2.4:

refresh-client [-C width,height] [-S] [-t target-client]
(alias: refresh)

tmux 1.6:

refresh-client [-S] [-t target-client]
(alias: refresh)

tmux 0.8:

refresh-client [-t target-client]
(alias: refresh)

Fields

tracking_cursor: bool

[-c] - return to tracking the cursor automatically

down: bool

[-D] - move the visible part of a window down by adjustment rows

request_clipboard: bool

[-l] - request the clipboard from the client using the xterm(1) escape sequence

left: bool

[-L] - move the visible part of a window left by adjustment columns

right: bool

[-R] - move the visible part of a window right by adjustment columns

status_line: bool

[-S] - only update the client’s status line

up: bool

[-U] - move the visible part of a window up by adjustment rows

allow_actions: Option<AllowActions<'a>>

[-A pane:state] - allows a control mode client to trigger actions on a pane

subscribe: Option<Subscribe<'a>>

[-B name:what:format]

size: Option<(usize, usize)>

[-C X,Y] - set the width and height of a control client [-C XxY] - set the width and height of a control client

flags: Option<ClientFlags>

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

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

[-t target-client] - specify the client

adjustment: Option<usize>

[adjustment] - moves the visible part up/down left/right by adjustment rows/columns

Implementations

impl<'a> RefreshClient<'a>

pub fn new() -> Self

pub fn tracking_cursor(self) -> Self

[-c] - return to tracking the cursor automatically

pub fn down(self) -> Self

[-D] - move the visible part of a window down by adjustment rows

pub fn request_clipboard(self) -> Self

[-l] - request the clipboard from the client using the xterm(1) escape sequence

pub fn left(self) -> Self

[-L] - move the visible part of a window left by adjustment columns

pub fn right(self) -> Self

[-R] - move the visible part of a window right by adjustment columns

pub fn status_line(self) -> Self

[-S] - only update the client’s status line

pub fn up(self) -> Self

[-U] - move the visible part of a window up by adjustment rows

pub fn allow_actions<S: Into<Cow<'a, str>>>(self, pane: S, state: State) -> Self

[-A pane:state] - allows a control mode client to trigger actions on a pane

pub fn subscribe<S: Into<Cow<'a, str>>>( self, name: S, what: Option<usize>, format: Option<usize> ) -> Self

[-B name:what:format]

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

[-C X,Y] - set the width and height of a control client [-C XxY] - set the width and height of a control client [-C @id:XxY] - set the width and height of a control client

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

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

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

[-t target-client] - specify the client

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

[adjustment] - moves the visible part up/down left/right by adjustment rows/columns

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

Trait Implementations

impl<'a> Clone for RefreshClient<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RefreshClient<'a>

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

Formats the value using the given formatter.

impl<'a> Default for RefreshClient<'a>

fn default() -> RefreshClient<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

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

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

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

impl<'a> StructuralPartialEq for RefreshClient<'a>