system-interface 0.6.5

Extensions to the Rust standard library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

#[cfg(not(windows))]
use posish::io::isatty;
#[cfg(windows)]
use std::{
    fs,
    io::{Stderr, StderrLock, Stdin, StdinLock, Stdout, StdoutLock},
    net,
};
#[cfg(not(windows))]
use unsafe_io::AsUnsafeHandle;

/// Extension for I/O handles which may or may not be terminals.
pub trait IsTerminal {
    /// Test whether this output stream is attached to a terminal.
    ///
    /// This operation is also known as `isatty`.
    fn is_terminal(&self) -> bool;
}

/// Implement `IsTerminal` for types that implement `AsRawFd`.
#[cfg(not(windows))]
impl<T> IsTerminal for T
where
    T: AsUnsafeHandle,
{
    #[inline]
    fn is_terminal(&self) -> bool {
        isatty(self)
    }
}

/// Implement `IsTerminal` for `Stdin`.
#[cfg(windows)]
impl IsTerminal for Stdin {
    #[inline]
    fn is_terminal(&self) -> bool {
        atty::is(atty::Stream::Stdin)
    }
}

/// Implement `IsTerminal` for `StdinLock`.
#[cfg(windows)]
impl<'a> IsTerminal for StdinLock<'a> {
    #[inline]
    fn is_terminal(&self) -> bool {
        atty::is(atty::Stream::Stdin)
    }
}

/// Implement `IsTerminal` for `Stdout`.
#[cfg(windows)]
impl IsTerminal for Stdout {
    #[inline]
    fn is_terminal(&self) -> bool {
        atty::is(atty::Stream::Stdout)
    }
}

/// Implement `IsTerminal` for `StdoutLock`.
#[cfg(windows)]
impl<'a> IsTerminal for StdoutLock<'a> {
    #[inline]
    fn is_terminal(&self) -> bool {
        atty::is(atty::Stream::Stdout)
    }
}

/// Implement `IsTerminal` for `Stderr`.
#[cfg(windows)]
impl IsTerminal for Stderr {
    #[inline]
    fn is_terminal(&self) -> bool {
        atty::is(atty::Stream::Stderr)
    }
}

/// Implement `IsTerminal` for `StderrLock`.
#[cfg(windows)]
impl<'a> IsTerminal for StderrLock<'a> {
    #[inline]
    fn is_terminal(&self) -> bool {
        atty::is(atty::Stream::Stderr)
    }
}

/// Implement `IsTerminal` for `std::fs::File`.
#[cfg(windows)]
impl<'a> IsTerminal for fs::File {
    #[inline]
    fn is_terminal(&self) -> bool {
        false
    }
}

/// Implement `IsTerminal` for `std::net::TcpStream`.
#[cfg(windows)]
impl<'a> IsTerminal for net::TcpStream {
    #[inline]
    fn is_terminal(&self) -> bool {
        false
    }
}

/// Implement `IsTerminal` for `cap_std::fs::File`.
#[cfg(all(windows, feature = "cap_std_impls"))]
impl<'a> IsTerminal for cap_std::fs::File {
    #[inline]
    fn is_terminal(&self) -> bool {
        false
    }
}

/// Implement `IsTerminal` for `cap_std::net::TcpStream`.
#[cfg(all(windows, feature = "cap_std_impls"))]
impl<'a> IsTerminal for cap_std::net::TcpStream {
    #[inline]
    fn is_terminal(&self) -> bool {
        false
    }
}

#[cfg(all(windows, feature = "socket2"))]
impl IsTerminal for socket2::Socket {
    #[inline]
    fn is_terminal(&self) -> bool {
        use unsafe_io::AsUnsafeSocket;
        self.as_tcp_stream_view().is_terminal()
    }
}