<!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 `EventedPty` trait in crate `alacritty`."><meta name="keywords" content="rust, rustlang, rust-lang, EventedPty"><title>alacritty::tty::EventedPty - 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 trait"><!--[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='../../alacritty/index.html'><img src='../../rust-logo.png' alt='logo' width='100'></a><p class='location'>Trait EventedPty</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.child_event_token">child_event_token</a><a href="#tymethod.next_child_event">next_child_event</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>alacritty</a>::<wbr><a href='index.html'>tty</a></p><script>window.sidebarCurrent = {name: 'EventedPty', ty: 'trait', 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/alacritty/tty/mod.rs.html#68-77' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>alacritty</a>::<wbr><a href='index.html'>tty</a>::<wbr><a class="trait" href=''>EventedPty</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait EventedPty: <a class="trait" href="../../alacritty/tty/trait.EventedReadWrite.html" title="trait alacritty::tty::EventedReadWrite">EventedReadWrite</a> {
fn <a href='#tymethod.child_event_token' class='fnname'>child_event_token</a>(&self) -> <a class="struct" href="../../mio/token/struct.Token.html" title="struct mio::token::Token">Token</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.next_child_event' class='fnname'>next_child_event</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../alacritty/tty/enum.ChildEvent.html" title="enum alacritty::tty::ChildEvent">ChildEvent</a>>;
}</pre></div><div class='docblock'><p>A pseudoterminal (or PTY)</p>
<p>This is a refinement of EventedReadWrite that also provides a channel through which we can be
notified if the PTY child process does something we care about (other than writing to the TTY).
In particular, this allows for race-free child exit notification on UNIX (cf. <code>SIGCHLD</code>).</p>
</div>
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.child_event_token' class='method'><code id='child_event_token.v'>fn <a href='#tymethod.child_event_token' class='fnname'>child_event_token</a>(&self) -> <a class="struct" href="../../mio/token/struct.Token.html" title="struct mio::token::Token">Token</a></code></h3><h3 id='tymethod.next_child_event' class='method'><code id='next_child_event.v'>fn <a href='#tymethod.next_child_event' class='fnname'>next_child_event</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../alacritty/tty/enum.ChildEvent.html" title="enum alacritty::tty::ChildEvent">ChildEvent</a>></code></h3><div class='docblock'><p>Tries to retrieve an event</p>
<p>Returns <code>Some(event)</code> on success, or <code>None</code> if there are no events to retrieve.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-EventedPty' class='impl'><code class='in-band'>impl EventedPty for <a class="struct" href="../../alacritty/tty/struct.Pty.html" title="struct alacritty::tty::Pty">Pty</a></code><a href='#impl-EventedPty' class='anchor'></a><a class='srclink' href='../../src/alacritty/tty/unix.rs.html#336-359' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.next_child_event' class="method hidden"><code id='next_child_event.v-1'>fn <a href='#method.next_child_event' class='fnname'>next_child_event</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../alacritty/tty/enum.ChildEvent.html" title="enum alacritty::tty::ChildEvent">ChildEvent</a>></code><a class='srclink' href='../../src/alacritty/tty/unix.rs.html#338-353' title='goto source code'>[src]</a></h4><h4 id='method.child_event_token' class="method hidden"><code id='child_event_token.v-1'>fn <a href='#method.child_event_token' class='fnname'>child_event_token</a>(&self) -> <a class="struct" href="../../mio/token/struct.Token.html" title="struct mio::token::Token">Token</a></code><a class='srclink' href='../../src/alacritty/tty/unix.rs.html#356-358' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../../implementors/alacritty/tty/trait.EventedPty.js">
</script></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 = "alacritty";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
