Struct tmux_interface::commands::key_bindings::send_keys::SendKeys

pub struct SendKeys<'a> {
    pub expand_formats: bool,
    pub hex: bool,
    pub client: bool,
    pub disable_lookup: bool,
    pub mouse_event: bool,
    pub copy_mode: bool,
    pub reset: bool,
    pub target_client: Option<Cow<'a, str>>,
    pub repeat_count: Option<usize>,
    pub target_pane: Option<Cow<'a, str>>,
    pub key: Option<Cow<'a, str>>,
}

Structure

Manual

tmux ^3.4:

send-keys [-FHKlMRX] [-c target-client] [-N repeat-count] [-t target-pane] key ...
(alias: send)

tmux ^3.1:

send-keys [-FHlMRX] [-N repeat-count] [-t target-pane] key ...
(alias: send)

tmux ^3.0:

send-keys [-HlMRX] [-N repeat-count] [-t target-pane] key ...
(alias: send)

tmux ^2.4:

send-keys [-lMRX] [-N repeat-count] [-t target-pane] key ...
(alias: send)

tmux ^2.1:

send-keys [-lMR] [-t target-pane] key ...
(alias: send)

tmux ^1.7:

send-keys [-lR] [-t target-pane] key ...
(alias: send)

tmux ^1.6:

send-keys [-R] [-t target-pane] key ...
(alias: send)

tmux ^0.8:

send-keys [-t target-window] key ...
(alias: send)

Fields

expand_formats: bool

[-F] - expand formats in arguments where appropriate

hex: bool

[-H] - expect each key to be a hexadecimal number for an ASCII character

client: bool

[-K] - keys are sent to target-client, so they are looked up in the client’s key table

disable_lookup: bool

[-l] - disable key name lookup and processes the keys as literal UTF-8 characters

mouse_event: bool

[-M] - pass through a mouse event

copy_mode: bool

[-R] - cause the terminal state to be reset

reset: bool

[-X] - send a command into copy mode

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

[-c target-client] - specify the target client

repeat_count: Option<usize>

[-N repeat-count] - specify a repeat count

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

[-t target-pane] - specify the target pane

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

key

Implementations

impl<'a> SendKeys<'a>

pub fn new() -> Self

pub fn expand_formats(self) -> Self

[-F] - expand formats in arguments where appropriate

pub fn hex(self) -> Self

[-H] - expect each key to be a hexadecimal number for an ASCII character

pub fn client(self) -> Self

[-K] - keys are sent to target-client, so they are looked up in the client’s key table

pub fn disable_lookup(self) -> Self

[-l] - disable key name lookup and processes the keys as literal UTF-8 characters

pub fn mouse_event(self) -> Self

[-M] - pass through a mouse event

pub fn copy_mode(self) -> Self

[-R] - cause the terminal state to be reset

pub fn reset(self) -> Self

[-X] - send a command into copy mode

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

[-N repeat-count] - specify a repeat count

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

[-c target-client] - specify the target client

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

[-t target-pane] - specify the target pane

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

key

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

Trait Implementations

impl<'a> Clone for SendKeys<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SendKeys<'a>

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

Formats the value using the given formatter.

impl<'a> Default for SendKeys<'a>

fn default() -> SendKeys<'a>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

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

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

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

impl<'a> StructuralPartialEq for SendKeys<'a>