mirror of
https://github.com/edg-l/edlang.git
synced 2024-10-18 15:08:17 +00:00
15 lines
14 KiB
HTML
15 lines
14 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Trait to determine if a descriptor/handle refers to a terminal/tty."><title>IsTerminal in is_terminal_polyfill - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-e935ef01ae1c1829.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="is_terminal_polyfill" data-themes="" data-resource-suffix="" data-rustdoc-version="1.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../is_terminal_polyfill/index.html">is_terminal_polyfill</a><span class="version">1.70.0</span></h2></div><h2 class="location"><a href="#">IsTerminal</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.is_terminal">is_terminal</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-IsTerminal-for-File">File</a></li><li><a href="#impl-IsTerminal-for-Stderr">Stderr</a></li><li><a href="#impl-IsTerminal-for-StderrLock%3C'_%3E">StderrLock<'_></a></li><li><a href="#impl-IsTerminal-for-Stdin">Stdin</a></li><li><a href="#impl-IsTerminal-for-StdinLock%3C'_%3E">StdinLock<'_></a></li><li><a href="#impl-IsTerminal-for-Stdout">Stdout</a></li><li><a href="#impl-IsTerminal-for-StdoutLock%3C'_%3E">StdoutLock<'_></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate is_terminal_polyfill</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../is_terminal_polyfill/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">is_terminal_polyfill</a>::<wbr><a class="trait" href="#">IsTerminal</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/is_terminal_polyfill/lib.rs.html#8-24">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait IsTerminal: Sealed {
|
||
// Required method
|
||
fn <a href="#tymethod.is_terminal" class="fn">is_terminal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait to determine if a descriptor/handle refers to a terminal/tty.</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.is_terminal" class="method"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#23">source</a><h4 class="code-header">fn <a href="#tymethod.is_terminal" class="fn">is_terminal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the descriptor/handle refers to a terminal/tty.</p>
|
||
<p>On platforms where Rust does not know how to detect a terminal yet, this will return
|
||
<code>false</code>. This will also return <code>false</code> if an unexpected error occurred, such as from
|
||
passing an invalid file descriptor.</p>
|
||
<h5 id="platform-specific-behavior"><a class="doc-anchor" href="#platform-specific-behavior">§</a>Platform-specific behavior</h5>
|
||
<p>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 <code>msys-</code> or <code>cygwin-</code> and ending in <code>-pty</code> will be considered terminals.
|
||
Note that this <a href="https://doc.rust-lang.org/1.78.0/std/io/index.html#platform-specific-behavior" title="mod std::io">may change in the future</a>.</p>
|
||
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-IsTerminal-for-File" class="impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#impl-IsTerminal-for-File" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IsTerminal.html" title="trait is_terminal_polyfill::IsTerminal">IsTerminal</a> for <a class="struct" href="https://doc.rust-lang.org/1.78.0/std/fs/struct.File.html" title="struct std::fs::File">File</a></h3></section></summary><div class="impl-items"><section id="method.is_terminal" class="method trait-impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#method.is_terminal" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_terminal" class="fn">is_terminal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IsTerminal-for-Stderr" class="impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#impl-IsTerminal-for-Stderr" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IsTerminal.html" title="trait is_terminal_polyfill::IsTerminal">IsTerminal</a> for <a class="struct" href="https://doc.rust-lang.org/1.78.0/std/io/stdio/struct.Stderr.html" title="struct std::io::stdio::Stderr">Stderr</a></h3></section></summary><div class="impl-items"><section id="method.is_terminal-1" class="method trait-impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#method.is_terminal-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_terminal" class="fn">is_terminal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IsTerminal-for-StderrLock%3C'_%3E" class="impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#impl-IsTerminal-for-StderrLock%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IsTerminal.html" title="trait is_terminal_polyfill::IsTerminal">IsTerminal</a> for <a class="struct" href="https://doc.rust-lang.org/1.78.0/std/io/stdio/struct.StderrLock.html" title="struct std::io::stdio::StderrLock">StderrLock</a><'_></h3></section></summary><div class="impl-items"><section id="method.is_terminal-2" class="method trait-impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#method.is_terminal-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_terminal" class="fn">is_terminal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IsTerminal-for-Stdin" class="impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#impl-IsTerminal-for-Stdin" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IsTerminal.html" title="trait is_terminal_polyfill::IsTerminal">IsTerminal</a> for <a class="struct" href="https://doc.rust-lang.org/1.78.0/std/io/stdio/struct.Stdin.html" title="struct std::io::stdio::Stdin">Stdin</a></h3></section></summary><div class="impl-items"><section id="method.is_terminal-3" class="method trait-impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#method.is_terminal-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_terminal" class="fn">is_terminal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IsTerminal-for-StdinLock%3C'_%3E" class="impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#impl-IsTerminal-for-StdinLock%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IsTerminal.html" title="trait is_terminal_polyfill::IsTerminal">IsTerminal</a> for <a class="struct" href="https://doc.rust-lang.org/1.78.0/std/io/stdio/struct.StdinLock.html" title="struct std::io::stdio::StdinLock">StdinLock</a><'_></h3></section></summary><div class="impl-items"><section id="method.is_terminal-4" class="method trait-impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#method.is_terminal-4" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_terminal" class="fn">is_terminal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IsTerminal-for-Stdout" class="impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#impl-IsTerminal-for-Stdout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IsTerminal.html" title="trait is_terminal_polyfill::IsTerminal">IsTerminal</a> for <a class="struct" href="https://doc.rust-lang.org/1.78.0/std/io/stdio/struct.Stdout.html" title="struct std::io::stdio::Stdout">Stdout</a></h3></section></summary><div class="impl-items"><section id="method.is_terminal-5" class="method trait-impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#method.is_terminal-5" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_terminal" class="fn">is_terminal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IsTerminal-for-StdoutLock%3C'_%3E" class="impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#impl-IsTerminal-for-StdoutLock%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IsTerminal.html" title="trait is_terminal_polyfill::IsTerminal">IsTerminal</a> for <a class="struct" href="https://doc.rust-lang.org/1.78.0/std/io/stdio/struct.StdoutLock.html" title="struct std::io::stdio::StdoutLock">StdoutLock</a><'_></h3></section></summary><div class="impl-items"><section id="method.is_terminal-6" class="method trait-impl"><a class="src rightside" href="../src/is_terminal_polyfill/lib.rs.html#43-51">source</a><a href="#method.is_terminal-6" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.is_terminal" class="fn">is_terminal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.bool.html">bool</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/is_terminal_polyfill/trait.IsTerminal.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html> |