TermTuiKeyBindings

ratatui_toolkit::primitives::termtui

Struct TermTuiKeyBindings 

Source 
pub struct TermTuiKeyBindings {
Show 28 fields
    pub enter_copy_mode: KeyEvent,
    pub copy_selection: KeyEvent,
    pub copy_exit: KeyEvent,
    pub copy_exit_alt: KeyEvent,
    pub copy_move_up: KeyEvent,
    pub copy_move_up_alt: KeyEvent,
    pub copy_move_down: KeyEvent,
    pub copy_move_down_alt: KeyEvent,
    pub copy_move_left: KeyEvent,
    pub copy_move_left_alt: KeyEvent,
    pub copy_move_right: KeyEvent,
    pub copy_move_right_alt: KeyEvent,
    pub copy_line_start: KeyEvent,
    pub copy_line_start_alt: KeyEvent,
    pub copy_line_end: KeyEvent,
    pub copy_line_end_alt: KeyEvent,
    pub copy_page_up: KeyEvent,
    pub copy_page_up_alt: KeyEvent,
    pub copy_page_down: KeyEvent,
    pub copy_page_down_alt: KeyEvent,
    pub copy_top: KeyEvent,
    pub copy_bottom: KeyEvent,
    pub copy_word_left: KeyEvent,
    pub copy_word_right: KeyEvent,
    pub copy_start_selection: KeyEvent,
    pub copy_start_selection_alt: KeyEvent,
    pub copy_and_exit: KeyEvent,
    pub copy_and_exit_alt: KeyEvent,

}
Expand description

Customizable keybindings for TermTui

This struct holds all keybindings that can be customized. Each field is a KeyEvent that specifies the key combination.

Fields§

§enter_copy_mode: KeyEvent

Enter copy mode (default: Ctrl+X)

§copy_selection: KeyEvent

Copy selection to clipboard (default: Ctrl+Shift+C)

§copy_exit: KeyEvent

Exit copy mode (default: Esc)

§copy_exit_alt: KeyEvent

Alternative exit copy mode (default: q)

§copy_move_up: KeyEvent

Move cursor up in copy mode (default: k or Up)

§copy_move_up_alt: KeyEvent

Alternative move up (default: Up arrow)

§copy_move_down: KeyEvent

Move cursor down in copy mode (default: j or Down)

§copy_move_down_alt: KeyEvent

Alternative move down (default: Down arrow)

§copy_move_left: KeyEvent

Move cursor left in copy mode (default: h or Left)

§copy_move_left_alt: KeyEvent

Alternative move left (default: Left arrow)

§copy_move_right: KeyEvent

Move cursor right in copy mode (default: l or Right)

§copy_move_right_alt: KeyEvent

Alternative move right (default: Right arrow)

§copy_line_start: KeyEvent

Move to line start (default: 0 or Home)

§copy_line_start_alt: KeyEvent

Alternative line start (default: Home)

§copy_line_end: KeyEvent

Move to line end (default: $ or End)

§copy_line_end_alt: KeyEvent

Alternative line end (default: End)

§copy_page_up: KeyEvent

Page up (default: u or PageUp)

§copy_page_up_alt: KeyEvent

Alternative page up (default: PageUp)

§copy_page_down: KeyEvent

Page down (default: d or PageDown)

§copy_page_down_alt: KeyEvent

Alternative page down (default: PageDown)

§copy_top: KeyEvent

Go to top (default: g)

§copy_bottom: KeyEvent

Go to bottom (default: G)

§copy_word_left: KeyEvent

Move word left (default: b)

§copy_word_right: KeyEvent

Move word right (default: w)

§copy_start_selection: KeyEvent

Start/toggle selection (default: v or Space)

§copy_start_selection_alt: KeyEvent

Alternative start selection (default: Space)

§copy_and_exit: KeyEvent

Copy and exit (default: y or Enter)

§copy_and_exit_alt: KeyEvent

Alternative copy and exit (default: Enter)

Implementations§

Source§

impl TermTuiKeyBindings

Source

pub fn new() -> Self

Create a new keybindings configuration with default values

Source§

impl TermTuiKeyBindings

Source

pub fn key_matches(key: &KeyEvent, binding: &KeyEvent) -> bool

Check if a key event matches a keybinding (ignoring state field differences)

Source§

impl TermTuiKeyBindings

Source

pub fn key_to_display_string(key: &KeyEvent) -> String

Convert a KeyEvent to a display string for showing in UI

Trait Implementations§

Source§

impl Clone for TermTuiKeyBindings

Source§

fn clone(&self) -> TermTuiKeyBindings

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TermTuiKeyBindings

Source§

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

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

impl Default for TermTuiKeyBindings

Source§

fn default() -> Self

Returns the “default value” for a type. 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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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