gecko-dev/third_party/rust/atty
Nathan Froyd b93bf873ba Bug 1502964 - part 2 - update winapi to froydnj/winapi-rs#aarch64; r=ted.mielczarek 2018-11-02 10:56:08 -04:00
..
examples
src Bug 1485409 - update crates to dispense with winapi 0.2.8 requirement; r=glandium 2018-08-28 21:37:30 -04:00
.cargo-checksum.json Bug 1502964 - part 2 - update winapi to froydnj/winapi-rs#aarch64; r=ted.mielczarek 2018-11-02 10:56:08 -04:00
CHANGELOG.md Bug 1485409 - update crates to dispense with winapi 0.2.8 requirement; r=glandium 2018-08-28 21:37:30 -04:00
Cargo.toml Bug 1485409 - update crates to dispense with winapi 0.2.8 requirement; r=glandium 2018-08-28 21:37:30 -04:00
LICENSE Bug 1485409 - update crates to dispense with winapi 0.2.8 requirement; r=glandium 2018-08-28 21:37:30 -04:00
README.md Bug 1485409 - update crates to dispense with winapi 0.2.8 requirement; r=glandium 2018-08-28 21:37:30 -04:00
appveyor.yml Bug 1485409 - update crates to dispense with winapi 0.2.8 requirement; r=glandium 2018-08-28 21:37:30 -04:00
rustfmt.toml Bug 1485409 - update crates to dispense with winapi 0.2.8 requirement; r=glandium 2018-08-28 21:37:30 -04:00

README.md

atty

Build Status Build status Coverage Status crates.io Released API docs Master API docs

are you or are you not a tty?

install

Add the following to your Cargo.toml

[dependencies]
atty = "0.2"

usage

extern crate atty;

use atty::Stream;

fn main() {
  if atty::is(Stream::Stdout) {
    println!("I'm a terminal");
  } else {
    println!("I'm not");
  }
}

testing

This library has been unit tested on both unix and windows platforms (via appveyor).

A simple example program is provided in this repo to test various tty's. By default.

It prints

$ cargo run --example atty
stdout? true
stderr? true
stdin? true

To test std in, pipe some text to the program

$ echo "test" | cargo run --example atty
stdout? true
stderr? true
stdin? false

To test std out, pipe the program to something

$ cargo run --example atty | grep std
stdout? false
stderr? true
stdin? true

To test std err, pipe the program to something redirecting std err

$ cargo run --example atty 2>&1 | grep std
stdout? false
stderr? false
stdin? true

Doug Tangren (softprops) 2015-2017