Struct tmux_interface::commands::status_line::display_message::DisplayMessage

pub struct DisplayMessage<'a> {
    pub list_format_vars: bool,
    pub forward_stdin: bool,
    pub disable_format: bool,
    pub ignore_keys: bool,
    pub print: bool,
    pub verbose: bool,
    pub target_client: Option<Cow<'a, str>>,
    pub delay: Option<usize>,
    pub target_pane: Option<Cow<'a, str>>,
    pub message: Option<Cow<'a, str>>,
}

Structure for displaying a message

Manual

tmux ^3.4:

display-message [-aIlNpv] [-c target-client] [-d delay] [-t target-pane] [message]
 (alias: display)

tmux ^3.2:

display-message [-aINpv] [-c target-client] [-d delay] [-t target-pane] [message]
 (alias: display)

tmux ^3.0:

display-message [-aIpv] [-c target-client] [-t target-pane] [message]
 (alias: display)

tmux ^2.9a:

display-message [-apv] [-c target-client] [-t target-pane] [message]
 (alias: display)

tmux ^1.5:

display-message [-p] [-c target-client] [-t target-pane] [message]
 (alias: display)

tmux ^1.2:

display-message [-p] [-t target-client] [message]
 (alias: display)

tmux ^1.0:

display-message [-t target-client] [message]
 (alias: display)

Fields

list_format_vars: bool

[-a] - list the format variables and their values

forward_stdin: bool

[-I] - forward any input read from stdin to the empty pane given by target-pane

disable_format: bool

[-l] - message is printed unchanged

ignore_keys: bool

[-N] - ignores key presses and closes only after the delay expires

print: bool

[-p] - the output is printed to stdout

verbose: bool

[-v] - print verbose logging as the format is parsed

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

[-c target-client] - target-client

delay: Option<usize>

[-d delay] - delay

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

[-t target-pane] - target-pane

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

[message] - message

Implementations

impl<'a> DisplayMessage<'a>

pub fn new() -> Self

pub fn list_format_vars(self) -> Self

[-a] - list the format variables and their values

pub fn forward_stdin(self) -> Self

[-I] - forward any input read from stdin to the empty pane given by target-pane

pub fn disable_format(self) -> Self

[-l] - message is printed unchanged

pub fn ignore_keys(self) -> Self

[-N] - ignores key presses and closes only after the delay expires

pub fn print(self) -> Self

[-p] - the output is printed to stdout

pub fn verbose(self) -> Self

[-v] - print verbose logging as the format is parsed

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

[-c target-client] - target-client

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

[-d delay] - delay

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

[-t target-pane] - target-pane

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

[message] - message

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

Trait Implementations

impl<'a> Clone for DisplayMessage<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DisplayMessage<'a>

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

Formats the value using the given formatter.

impl<'a> Default for DisplayMessage<'a>

fn default() -> DisplayMessage<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

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

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

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

impl<'a> StructuralPartialEq for DisplayMessage<'a>