Skip to main content

SendKeys

Struct SendKeys 

Source
pub struct SendKeys { /* private fields */ }
Expand description

Typed arguments for send-keys.

Implementations§

Source§

impl SendKeys

Source

pub const fn new() -> Self

Creates an empty key sequence.

Source

pub fn key(self, key: impl Into<OsString>) -> Self

Adds one key name or literal string.

Source

pub fn keys<I, S>(self, keys: I) -> Self
where I: IntoIterator<Item = S>, S: Into<OsString>,

Adds multiple key names.

Source

pub const fn literal(self, enabled: bool) -> Self

Sends input literally (-l).

Source

pub const fn hexadecimal(self, enabled: bool) -> Self

Treats each key as hexadecimal (-H).

Source

pub const fn reset(self, enabled: bool) -> Self

Resets terminal state before sending input (-R).

Source

pub fn repeat(self, count: u32) -> Result<Self>

Repeats the sequence a non-zero number of times.

Source

pub const fn enter(self, enabled: bool) -> Self

Appends an Enter key after the input sequence.

Source

pub const fn suppress_history(self, enabled: bool) -> Self

Sends a leading space before input so shells configured accordingly omit it from history.

Source

pub fn copy_mode_command(self, command: impl Into<OsString>) -> Self

Sends a command to copy mode (-X) instead of ordinary keys.

Source

pub const fn expand_formats(self, enabled: bool) -> Self

Expands tmux formats in the supplied keys (-F).

Source

pub fn target_client(self, client: ClientName) -> Self

Targets an attached client (-c). Requires tmux 3.4+.

Source

pub const fn key_name(self, enabled: bool) -> Self

Interprets input as key names for a target client (-K). Requires tmux 3.4+.

Source

pub const fn sensitive(self, enabled: bool) -> Self

Redacts input keys or the copy-mode command from command diagnostics.

Trait Implementations§

Source§

impl Clone for SendKeys

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SendKeys

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SendKeys

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for SendKeys

Source§

impl PartialEq for SendKeys

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SendKeys

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more