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

Add more documentation about the IsTty trait (#461)

Browse Source
This commit is contained in:
Arne Beer 2020-07-12 12:16:18 +02:00 committed by GitHub
parent 5365bf976c
commit 30b7d99364
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/tty.rs
View File

@ -11,6 +11,13 @@ use std::os::windows::io::AsRawHandle;
use winapi::um::consoleapi::GetConsoleMode; use winapi::um::consoleapi::GetConsoleMode;
/// Adds the `is_tty` method to types that might represent a terminal /// Adds the `is_tty` method to types that might represent a terminal
///
/// ```rust
/// use std::io::stdout;
/// use crossterm::tty::IsTty;
///
/// let is_tty: bool = stdout().is_tty();
/// ```
pub trait IsTty { pub trait IsTty {
/// Returns true when an instance is a terminal teletype, otherwise false. /// Returns true when an instance is a terminal teletype, otherwise false.
fn is_tty(&self) -> bool; fn is_tty(&self) -> bool;