blasthavers/minicrossterm
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: Add some links related to raw mode (#581)

Browse Source
This commit is contained in:
mgunyho 2021-07-26 19:21:21 +03:00 committed by GitHub
parent c983000b51
commit 24d0f561e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/event.rs
View File

@ -15,7 +15,7 @@
//! * use the [`read`](fn.read.html) & [`poll`](fn.poll.html) functions on any, but same, thread //! * use the [`read`](fn.read.html) & [`poll`](fn.poll.html) functions on any, but same, thread
//! * or the [`EventStream`](struct.EventStream.html). //! * or the [`EventStream`](struct.EventStream.html).
//! //!
//! **Make sure to enable raw mode in order for keyboard events to work properly** //! **Make sure to enable [raw mode](../terminal/#raw-mode) in order for keyboard events to work properly**
//! //!
//! ## Mouse Events //! ## Mouse Events
//! //!

2
src/terminal.rs
View File

@ -58,6 +58,8 @@
//! - Special keys like backspace and CTL+C will not be processed by terminal driver //! - Special keys like backspace and CTL+C will not be processed by terminal driver
//! - New line character will not be processed therefore `println!` can't be used, use `write!` instead //! - New line character will not be processed therefore `println!` can't be used, use `write!` instead
//! //!
//! Raw mode can be enabled/disabled with the [enable_raw_mode](terminal::enable_raw_mode) and [disable_raw_mode](terminal::disable_raw_mode) functions.
//!
//! ## Examples //! ## Examples
//! //!
//! ```no_run //! ```no_run