Struct crossterm::event::PushKeyboardEnhancementFlags

pub struct PushKeyboardEnhancementFlags(pub KeyboardEnhancementFlags);

A command that enables the kitty keyboard protocol, which adds extra information to keyboard events and removes ambiguity for modifier keys.

It should be paired with PopKeyboardEnhancementFlags at the end of execution.

Example usage:

use std::io::{Write, stdout};
use crossterm::execute;
use crossterm::event::{
    KeyboardEnhancementFlags,
    PushKeyboardEnhancementFlags,
    PopKeyboardEnhancementFlags
};

let mut stdout = stdout();

execute!(
    stdout,
    PushKeyboardEnhancementFlags(
        KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES
    )
);

// ...

execute!(stdout, PopKeyboardEnhancementFlags);

Note that, currently, only the following support this protocol:

• kitty terminal
• foot terminal
• WezTerm terminal
• notcurses library
• neovim text editor
• kakoune text editor
• dte text editor

Tuple Fields

0: KeyboardEnhancementFlags

Trait Implementations

impl Clone for PushKeyboardEnhancementFlags

fn clone(&self) -> PushKeyboardEnhancementFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Command for PushKeyboardEnhancementFlags

fn write_ansi(&self, f: &mut impl Write) -> Result

Write an ANSI representation of this command to the given writer. An ANSI code can manipulate the terminal by writing it to the terminal buffer. However, only Windows 10 and UNIX systems support this.

fn execute_winapi(&self) -> Result<()>

Execute this command.

fn is_ansi_code_supported(&self) -> bool

Returns whether the ANSI code representation of this command is supported by windows.

impl Debug for PushKeyboardEnhancementFlags

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

Formats the value using the given formatter.

impl PartialEq<PushKeyboardEnhancementFlags> for PushKeyboardEnhancementFlags

fn eq(&self, other: &PushKeyboardEnhancementFlags) -> 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 Copy for PushKeyboardEnhancementFlags

impl Eq for PushKeyboardEnhancementFlags

impl StructuralEq for PushKeyboardEnhancementFlags

impl StructuralPartialEq for PushKeyboardEnhancementFlags