Skip to main content

CommandPrompt

Struct CommandPrompt 

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

Typed arguments for command-prompt.

Implementations§

Source§

impl CommandPrompt

Source

pub fn new(template: impl Into<OsString>) -> Self

Creates a background prompt with a tmux command template.

Source

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

Sets prompt text.

Source

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

Sets prefilled inputs.

Source

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

Targets an attached client.

Source

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

Accepts one key press.

Source

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

Accepts keys but no text input.

Source

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

Runs the template after every input change.

Source

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

Restricts input to numbers.

Source

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

Selects the history namespace.

Source

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

Expands formats in the command template.

Source

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

Treats a comma-containing prompt literally. Requires tmux 3.6+.

Source

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

Exits when backspace empties input. Requires tmux 3.7+.

Source

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

Keeps panes unfrozen. Requires tmux 3.7+.

Trait Implementations§

Source§

impl Clone for CommandPrompt

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 CommandPrompt

Source§

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

Formats the value using the given formatter. Read more

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