Struct tmux_interface::commands::status_line::command_prompt::CommandPrompt

pub struct CommandPrompt<'a> {
    pub one_keypress: bool,
    pub background: bool,
    pub expand_as_format: bool,
    pub on_input_change: bool,
    pub key_name: bool,
    pub numeric: bool,
    pub prompt_type: Option<PromptType>,
    pub for_window: bool,
    pub inputs: Option<Cow<'a, str>>,
    pub prompts: Option<Cow<'a, str>>,
    pub target_client: Option<Cow<'a, str>>,
    pub template: Option<Cow<'a, str>>,
}

Structure for open the command prompt in a client

Manual

tmux ^3.3:

command-prompt [-1bFikN] [-I inputs] [-p prompts] [-t target-client] [-T prompt-type] [template]

tmux ^3.2:

command-prompt [-1ikNTW] [-I inputs] [-p prompts] [-t target-client] [template]

tmux ^3.1:

command-prompt [-1ikN] [-I inputs] [-p prompts] [-t target-client] [template]

tmux ^3.0:

command-prompt [-1Ni] [-I inputs] [-p prompts] [-t target-client] [template]

tmux ^2.4:

command-prompt [-1i] [-I inputs] [-p prompts] [-t target-client] [template]

tmux ^1.5:

command-prompt [-I inputs] [-p prompts] [-t target-client] [template]

tmux ^1.0:

command-prompt [-p prompts] [-t target-client] [template]

tmux ^0.8:

command-prompt [-t target-client] [template]

Fields

one_keypress: bool

[-1] - makes the prompt only accept one key press

background: bool

[-b] - the prompt is shown in the background and the invoking client does not exit until it is dismissed

expand_as_format: bool

[-F] -

on_input_change: bool

[-i] execute the command every time the prompt input changes

key_name: bool

[-k] - the key press is translated to a key name

numeric: bool

[-N] - makes the prompt only accept numeric key presses

prompt_type: Option<PromptType>

[-T prompt-type] - tells tmux the prompt type. This affects what completions are offered when Tab is pressed

for_window: bool

[-W] - indicates the prompt is for a window.

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

[-I inputs] - comma-separated list of the initial text for each prompt

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

[-p prompts] - prompts is a comma-separated list of prompts which are displayed in order

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

[-t target-client] - target-client

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

[template] - template

Implementations

impl<'a> CommandPrompt<'a>

pub fn new() -> Self

pub fn one_keypress(self) -> Self

[-1] makesthe prompt only accept one key press

pub fn on_input_change(self) -> Self

[-i] execute the command every time the prompt input changes

pub fn key_name(self) -> Self

[-k] - the key press is translated to a key name

pub fn numeric(self) -> Self

[-N] - makes the prompt only accept numeric key presses

pub fn prompt_type(self, prompt_type: PromptType) -> Self

[-T prompt-type]

pub fn for_window(self) -> Self

[-W] - indicates the prompt is for a window.

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

[-I inputs] - comma-separated list of the initial text for each prompt

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

[-p prompts] - prompts is a comma-separated list of prompts which are displayed in order

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

[-t target-client] - target-client

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

[template] - template

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

Trait Implementations

impl<'a> Clone for CommandPrompt<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CommandPrompt<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CommandPrompt<'a>

fn default() -> CommandPrompt<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

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

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

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

impl<'a> StructuralPartialEq for CommandPrompt<'a>