Skip to content

Commit

Permalink
Rollup merge of #109687 - joshtriplett:document-windows-isterminal-he…
Browse files Browse the repository at this point in the history
…uristics, r=BurntSushi

Document the heuristics IsTerminal uses on Windows

Suggested by `@BurntSushi.`
  • Loading branch information
matthiaskrgr authored Mar 28, 2023
2 parents cad4893 + b38732f commit a694960
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions library/std/src/io/stdio.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1054,6 +1054,15 @@ pub trait IsTerminal: crate::sealed::Sealed {
/// On platforms where Rust does not know how to detect a terminal yet, this will return
/// `false`. This will also return `false` if an unexpected error occurred, such as from
/// passing an invalid file descriptor.
///
/// # Platform-specific behavior
///
/// On Windows, in addition to detecting consoles, this currently uses some heuristics to
/// detect older msys/cygwin/mingw pseudo-terminals based on device name: devices with names
/// starting with `msys-` or `cygwin-` and ending in `-pty` will be considered terminals.
/// Note that this [may change in the future][changes].
///
/// [changes]: io#platform-specific-behavior
fn is_terminal(&self) -> bool;
}

Expand Down

0 comments on commit a694960

Please sign in to comment.