atty

Crates.ioatty
lib.rsatty
version0.2.14
sourcesrc
created_at2015-07-10 00:25:05.224059
updated_at2020-01-05 22:19:33.123499
descriptionA simple interface for querying atty
homepagehttps://github.com/softprops/atty
repositoryhttps://github.com/softprops/atty
max_upload_size
id2572
size14,565
cargo (github:rustpq:cargo)

documentation

http://softprops.github.io/atty

README

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

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-2019

Commit count: 132

cargo fmt