|
|
<!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="API documentation for the Rust `pty` mod in crate `nix`."><meta name="keywords" content="rust, rustlang, rust-lang, pty"><title>nix::pty - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../nix/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module pty</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>nix</a></p><script>window.sidebarCurrent = {name: 'pty', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/nix/pty.rs.html#1-326' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>nix</a>::<wbr><a class="mod" href=''>pty</a></span></h1><div class='docblock'><p>Create master and slave virtual pseudo-terminals (PTYs)</p>
|
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.ForkptyResult.html" title='nix::pty::ForkptyResult struct'>ForkptyResult</a></td><td class='docblock-short'><p>Representation of a master with a forked pty</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.OpenptyResult.html" title='nix::pty::OpenptyResult struct'>OpenptyResult</a></td><td class='docblock-short'><p>Representation of a master/slave pty pair</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.PtyMaster.html" title='nix::pty::PtyMaster struct'>PtyMaster</a></td><td class='docblock-short'><p>Representation of the Master device in a master/slave pty pair</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Winsize.html" title='nix::pty::Winsize struct'>Winsize</a></td><td class='docblock-short'></td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="fn" href="fn.forkpty.html" title='nix::pty::forkpty fn'>forkpty</a></td><td class='docblock-short'><p>Create a new pseudoterminal, returning the master file descriptor and forked pid.
|
|
|
in <code>ForkptyResult</code>
|
|
|
(see <a href="http://man7.org/linux/man-pages/man3/forkpty.3.html"><code>forkpty</code></a>).</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.grantpt.html" title='nix::pty::grantpt fn'>grantpt</a></td><td class='docblock-short'><p>Grant access to a slave pseudoterminal (see
|
|
|
<a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/grantpt.html"><code>grantpt(3)</code></a>)</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.openpty.html" title='nix::pty::openpty fn'>openpty</a></td><td class='docblock-short'><p>Create a new pseudoterminal, returning the slave and master file descriptors
|
|
|
in <code>OpenptyResult</code>
|
|
|
(see <a href="http://man7.org/linux/man-pages/man3/openpty.3.html"><code>openpty</code></a>).</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.posix_openpt.html" title='nix::pty::posix_openpt fn'>posix_openpt</a></td><td class='docblock-short'><p>Open a pseudoterminal device (see
|
|
|
<a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/posix_openpt.html"><code>posix_openpt(3)</code></a>)</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.ptsname.html" title='nix::pty::ptsname fn'>ptsname</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><p>Get the name of the slave pseudoterminal (see
|
|
|
<a href="http://man7.org/linux/man-pages/man3/ptsname.3.html"><code>ptsname(3)</code></a>)</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.ptsname_r.html" title='nix::pty::ptsname_r fn'>ptsname_r</a></td><td class='docblock-short'><p>Get the name of the slave pseudoterminal (see
|
|
|
<a href="http://man7.org/linux/man-pages/man3/ptsname.3.html"><code>ptsname(3)</code></a>)</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.unlockpt.html" title='nix::pty::unlockpt fn'>unlockpt</a></td><td class='docblock-short'><p>Unlock a pseudoterminal master/slave pseudoterminal pair (see
|
|
|
<a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/unlockpt.html"><code>unlockpt(3)</code></a>)</p>
|
|
|
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="type" href="type.SessionId.html" title='nix::pty::SessionId type'>SessionId</a></td><td class='docblock-short'></td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "nix";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |
