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

Edited some docs (#324)

Browse Source
This commit is contained in:
Timon 2019-11-21 19:40:18 +01:00 committed by GitHub
parent 7333de70a7
commit 9a34b1c1d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib.rs
View File

@ -29,7 +29,7 @@
//! //!
//! * Functions can execute commands on types that implement Write. Functions are easier to use and debug. //! * Functions can execute commands on types that implement Write. Functions are easier to use and debug.
//! There is a disadvantage, and that is that there is a boilerplate code involved. //! There is a disadvantage, and that is that there is a boilerplate code involved.
//! * Macros are generally seen as more difficult but offer an API with less boilerplate code. If you are //! * Macros are generally seen as more difficult and aren't always well supported by editors but offer an API with less boilerplate code. If you are
//! not afraid of macros, this is a recommendation. //! not afraid of macros, this is a recommendation.
//! //!
//! Linux and Windows 10 systems support ANSI escape codes. Those ANSI escape codes are strings or rather a //! Linux and Windows 10 systems support ANSI escape codes. Those ANSI escape codes are strings or rather a
@ -39,7 +39,7 @@
//! ### Supported Commands //! ### Supported Commands
//! //!
//! - Module `cursor` //! - Module `cursor`
//! - Visibility - [`Show`](cursor/struct.Show.html), [`Hide`](cursor/struct.Show.html) //! - Visibility - [`Show`](cursor/struct.Show.html), [`Hide`](cursor/struct.Hide.html)
//! - Appearance - [`EnableBlinking`](cursor/struct.EnableBlinking.html), //! - Appearance - [`EnableBlinking`](cursor/struct.EnableBlinking.html),
//! [`DisableBlinking`](cursor/struct.DisableBlinking.html) //! [`DisableBlinking`](cursor/struct.DisableBlinking.html)
//! - Position - //! - Position -
@ -235,7 +235,7 @@ pub use utils::{Command, ErrorKind, ExecutableCommand, Output, QueueableCommand,
pub mod cursor; pub mod cursor;
/// A module to read events. /// A module to read events.
pub mod event; pub mod event;
/// A module to work with the terminal screen. /// A module to work with the terminal screen and modes.
pub mod screen; pub mod screen;
/// A module to apply attributes and colors on your text. /// A module to apply attributes and colors on your text.
pub mod style; pub mod style;

4
src/utils/command.rs
View File

@ -28,14 +28,14 @@ pub trait Command {
fn execute_winapi(&self) -> Result<()>; fn execute_winapi(&self) -> Result<()>;
} }
/// A trait that defines behaviour for a command that can be used to be executed at a later time point. /// A trait that defines behaviour for a command which can be executed at a later time.
/// This can be used in order to get more performance. /// This can be used in order to get more performance.
pub trait QueueableCommand<T: Display>: Sized { pub trait QueueableCommand<T: Display>: Sized {
/// Queues the given command for later execution. /// Queues the given command for later execution.
fn queue(&mut self, command: impl Command<AnsiType = T>) -> Result<&mut Self>; fn queue(&mut self, command: impl Command<AnsiType = T>) -> Result<&mut Self>;
} }
/// A trait that defines behaviour for a command that will be executed immediately. /// A trait that defines behaviour for a command which will be executed immediately.
pub trait ExecutableCommand<T: Display>: Sized { pub trait ExecutableCommand<T: Display>: Sized {
/// Execute the given command directly. /// Execute the given command directly.
fn execute(&mut self, command: impl Command<AnsiType = T>) -> Result<&mut Self>; fn execute(&mut self, command: impl Command<AnsiType = T>) -> Result<&mut Self>;