Struct tmux_interface::commands::status_line::display_message::DisplayMessage
source · 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>>,
}
Expand description
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§
source§impl<'a> DisplayMessage<'a>
impl<'a> DisplayMessage<'a>
pub fn new() -> Self
sourcepub fn list_format_vars(self) -> Self
pub fn list_format_vars(self) -> Self
[-a]
- list the format variables and their values
sourcepub fn forward_stdin(self) -> Self
pub fn forward_stdin(self) -> Self
[-I]
- forward any input read from stdin to the empty pane given by target-pane
sourcepub fn disable_format(self) -> Self
pub fn disable_format(self) -> Self
[-l]
- message is printed unchanged
sourcepub fn ignore_keys(self) -> Self
pub fn ignore_keys(self) -> Self
[-N]
- ignores key presses and closes only after the delay expires
sourcepub fn target_client<S: Into<Cow<'a, str>>>(self, target_client: S) -> Self
pub fn target_client<S: Into<Cow<'a, str>>>(self, target_client: S) -> Self
[-c target-client]
- target-client
sourcepub fn target_pane<S: Into<Cow<'a, str>>>(self, target_pane: S) -> Self
pub fn target_pane<S: Into<Cow<'a, str>>>(self, target_pane: S) -> Self
[-t target-pane]
- target-pane
pub fn build(self) -> TmuxCommand<'a>
Trait Implementations§
source§impl<'a> Clone for DisplayMessage<'a>
impl<'a> Clone for DisplayMessage<'a>
source§fn clone(&self) -> DisplayMessage<'a>
fn clone(&self) -> DisplayMessage<'a>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'a> Debug for DisplayMessage<'a>
impl<'a> Debug for DisplayMessage<'a>
source§impl<'a> Default for DisplayMessage<'a>
impl<'a> Default for DisplayMessage<'a>
source§fn default() -> DisplayMessage<'a>
fn default() -> DisplayMessage<'a>
source§impl<'a> From<DisplayMessage<'a>> for TmuxCommand<'a>
impl<'a> From<DisplayMessage<'a>> for TmuxCommand<'a>
source§fn from(item: DisplayMessage<'a>) -> Self
fn from(item: DisplayMessage<'a>) -> Self
source§impl<'a> Hash for DisplayMessage<'a>
impl<'a> Hash for DisplayMessage<'a>
source§impl<'a> Ord for DisplayMessage<'a>
impl<'a> Ord for DisplayMessage<'a>
source§fn cmp(&self, other: &DisplayMessage<'a>) -> Ordering
fn cmp(&self, other: &DisplayMessage<'a>) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl<'a> PartialEq for DisplayMessage<'a>
impl<'a> PartialEq for DisplayMessage<'a>
source§fn eq(&self, other: &DisplayMessage<'a>) -> bool
fn eq(&self, other: &DisplayMessage<'a>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<'a> PartialOrd for DisplayMessage<'a>
impl<'a> PartialOrd for DisplayMessage<'a>
source§fn partial_cmp(&self, other: &DisplayMessage<'a>) -> Option<Ordering>
fn partial_cmp(&self, other: &DisplayMessage<'a>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more