Skip to content

Commit 1354a38

Browse files
committed
Document the heuristics IsTerminal uses on Windows
1 parent 5bf139e commit 1354a38

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

library/std/src/io/stdio.rs

+4
Original file line numberDiff line numberDiff line change
@@ -1054,6 +1054,10 @@ pub trait IsTerminal: crate::sealed::Sealed {
10541054
/// On platforms where Rust does not know how to detect a terminal yet, this will return
10551055
/// `false`. This will also return `false` if an unexpected error occurred, such as from
10561056
/// passing an invalid file descriptor.
1057+
///
1058+
/// On Windows, in addition to detecting consoles, this currently uses some heuristics to
1059+
/// detect older msys/cygwin/mingw pseudo-terminals based on device name: devices with names
1060+
/// starting with `msys-` or `cygwin-` and ending in `-pty` will be considered terminals.
10571061
fn is_terminal(&self) -> bool;
10581062
}
10591063

0 commit comments

Comments
 (0)