tree: 48484e14ebbf6e79b5fafe6788668f28ddec7aed [path history] [tgz]
  1. .cargo-checksum.json
  2. .travis.yml
  3. CHANGELOG.md
  4. Cargo.toml
  5. LICENSE
  6. README.md
  7. appveyor.yml
  8. examples/
  9. rustfmt.toml
  10. src/
vendor/atty/README.md

atty

Build Status Build status Coverage Status crates.io

are you or are you not a tty?

Documentation

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