blob: 7c027bf848cb6d815ff6929a3ae5512040dce1d0 [file] [log] [blame]
<!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="Describes the readiness state of an I/O resources."><meta name="keywords" content="rust, rustlang, rust-lang, Ready"><title>Ready in tokio::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[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">&#9776;</button><a class="sidebar-logo" href="../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Ready</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Associated Constants</a></h3><ul class="block"><li><a href="#associatedconstant.ALL">ALL</a></li><li><a href="#associatedconstant.EMPTY">EMPTY</a></li><li><a href="#associatedconstant.READABLE">READABLE</a></li><li><a href="#associatedconstant.READ_CLOSED">READ_CLOSED</a></li><li><a href="#associatedconstant.WRITABLE">WRITABLE</a></li><li><a href="#associatedconstant.WRITE_CLOSED">WRITE_CLOSED</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.is_empty">is_empty</a></li><li><a href="#method.is_read_closed">is_read_closed</a></li><li><a href="#method.is_readable">is_readable</a></li><li><a href="#method.is_writable">is_writable</a></li><li><a href="#method.is_write_closed">is_write_closed</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-BitAnd%3CReady%3E-for-Ready">BitAnd&lt;Ready&gt;</a></li><li><a href="#impl-BitOr%3CReady%3E-for-Ready">BitOr&lt;Ready&gt;</a></li><li><a href="#impl-BitOrAssign%3CReady%3E-for-Ready">BitOrAssign&lt;Ready&gt;</a></li><li><a href="#impl-Clone-for-Ready">Clone</a></li><li><a href="#impl-Copy-for-Ready">Copy</a></li><li><a href="#impl-Debug-for-Ready">Debug</a></li><li><a href="#impl-Eq-for-Ready">Eq</a></li><li><a href="#impl-Ord-for-Ready">Ord</a></li><li><a href="#impl-PartialEq%3CReady%3E-for-Ready">PartialEq&lt;Ready&gt;</a></li><li><a href="#impl-PartialOrd%3CReady%3E-for-Ready">PartialOrd&lt;Ready&gt;</a></li><li><a href="#impl-StructuralEq-for-Ready">StructuralEq</a></li><li><a href="#impl-StructuralPartialEq-for-Ready">StructuralPartialEq</a></li><li><a href="#impl-Sub%3CReady%3E-for-Ready">Sub&lt;Ready&gt;</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Ready">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Ready">Send</a></li><li><a href="#impl-Sync-for-Ready">Sync</a></li><li><a href="#impl-Unpin-for-Ready">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Ready">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Ready">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Ready">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Ready">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-Ready">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-Ready">Into&lt;U&gt;</a></li><li><a href="#impl-ToOwned-for-Ready">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Ready">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-Ready">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In tokio::io</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">tokio</a>::<wbr><a href="index.html">io</a>::<wbr><a class="struct" href="#">Ready</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tokio/io/ready.rs.html#16">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Ready(_);</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Describes the readiness state of an I/O resources.</p>
<p><code>Ready</code> tracks which operation an I/O resource is ready to perform.</p>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#18-175">source</a><a href="#impl-Ready" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedconstant.EMPTY" class="associatedconstant has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#20">source</a><h4 class="code-header">pub const <a href="#associatedconstant.EMPTY" class="constant">EMPTY</a>: <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a> = _</h4></section></summary><div class="docblock"><p>Returns the empty <code>Ready</code> set.</p>
</div></details><details class="rustdoc-toggle" open><summary><section id="associatedconstant.READABLE" class="associatedconstant has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#23">source</a><h4 class="code-header">pub const <a href="#associatedconstant.READABLE" class="constant">READABLE</a>: <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a> = _</h4></section></summary><div class="docblock"><p>Returns a <code>Ready</code> representing readable readiness.</p>
</div></details><details class="rustdoc-toggle" open><summary><section id="associatedconstant.WRITABLE" class="associatedconstant has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#26">source</a><h4 class="code-header">pub const <a href="#associatedconstant.WRITABLE" class="constant">WRITABLE</a>: <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a> = _</h4></section></summary><div class="docblock"><p>Returns a <code>Ready</code> representing writable readiness.</p>
</div></details><details class="rustdoc-toggle" open><summary><section id="associatedconstant.READ_CLOSED" class="associatedconstant has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#29">source</a><h4 class="code-header">pub const <a href="#associatedconstant.READ_CLOSED" class="constant">READ_CLOSED</a>: <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a> = _</h4></section></summary><div class="docblock"><p>Returns a <code>Ready</code> representing read closed readiness.</p>
</div></details><details class="rustdoc-toggle" open><summary><section id="associatedconstant.WRITE_CLOSED" class="associatedconstant has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#32">source</a><h4 class="code-header">pub const <a href="#associatedconstant.WRITE_CLOSED" class="constant">WRITE_CLOSED</a>: <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a> = _</h4></section></summary><div class="docblock"><p>Returns a <code>Ready</code> representing write closed readiness.</p>
</div></details><details class="rustdoc-toggle" open><summary><section id="associatedconstant.ALL" class="associatedconstant has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#35">source</a><h4 class="code-header">pub const <a href="#associatedconstant.ALL" class="constant">ALL</a>: <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a> = _</h4></section></summary><div class="docblock"><p>Returns a <code>Ready</code> representing readiness for all operations.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_empty" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#81-83">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fnname">is_empty</a>(self) -&gt; bool</h4></section></summary><div class="docblock"><p>Returns true if <code>Ready</code> is the empty set.</p>
<h5 id="examples"><a href="#examples">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::io::Ready;
<span class="macro">assert!</span>(Ready::EMPTY.is_empty());
<span class="macro">assert!</span>(!Ready::READABLE.is_empty());</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_readable" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#97-99">source</a><h4 class="code-header">pub fn <a href="#method.is_readable" class="fnname">is_readable</a>(self) -&gt; bool</h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the value includes <code>readable</code>.</p>
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::io::Ready;
<span class="macro">assert!</span>(!Ready::EMPTY.is_readable());
<span class="macro">assert!</span>(Ready::READABLE.is_readable());
<span class="macro">assert!</span>(Ready::READ_CLOSED.is_readable());
<span class="macro">assert!</span>(!Ready::WRITABLE.is_readable());</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_writable" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#113-115">source</a><h4 class="code-header">pub fn <a href="#method.is_writable" class="fnname">is_writable</a>(self) -&gt; bool</h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the value includes writable <code>readiness</code>.</p>
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::io::Ready;
<span class="macro">assert!</span>(!Ready::EMPTY.is_writable());
<span class="macro">assert!</span>(!Ready::READABLE.is_writable());
<span class="macro">assert!</span>(Ready::WRITABLE.is_writable());
<span class="macro">assert!</span>(Ready::WRITE_CLOSED.is_writable());</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_read_closed" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#128-130">source</a><h4 class="code-header">pub fn <a href="#method.is_read_closed" class="fnname">is_read_closed</a>(self) -&gt; bool</h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the value includes read-closed <code>readiness</code>.</p>
<h5 id="examples-3"><a href="#examples-3">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::io::Ready;
<span class="macro">assert!</span>(!Ready::EMPTY.is_read_closed());
<span class="macro">assert!</span>(!Ready::READABLE.is_read_closed());
<span class="macro">assert!</span>(Ready::READ_CLOSED.is_read_closed());</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_write_closed" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#143-145">source</a><h4 class="code-header">pub fn <a href="#method.is_write_closed" class="fnname">is_write_closed</a>(self) -&gt; bool</h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the value includes write-closed <code>readiness</code>.</p>
<h5 id="examples-4"><a href="#examples-4">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::io::Ready;
<span class="macro">assert!</span>(!Ready::EMPTY.is_write_closed());
<span class="macro">assert!</span>(!Ready::WRITABLE.is_write_closed());
<span class="macro">assert!</span>(Ready::WRITE_CLOSED.is_write_closed());</code></pre></div>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-BitAnd%3CReady%3E-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#223-230">source</a><a href="#impl-BitAnd%3CReady%3E-for-Ready" class="anchor"></a><h3 class="code-header">impl BitAnd&lt;<a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>&gt; for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Output</a> = <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h4></section></summary><div class='docblock'>The resulting type after applying the <code>&amp;</code> operator.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bitand" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#227-229">source</a><a href="#method.bitand" class="anchor"></a><h4 class="code-header">fn <a class="fnname">bitand</a>(self, other: <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>) -&gt; <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h4></section></summary><div class='docblock'>Performs the <code>&amp;</code> operation. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-BitOr%3CReady%3E-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#207-214">source</a><a href="#impl-BitOr%3CReady%3E-for-Ready" class="anchor"></a><h3 class="code-header">impl BitOr&lt;<a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>&gt; for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Output</a> = <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h4></section></summary><div class='docblock'>The resulting type after applying the <code>|</code> operator.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bitor" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#211-213">source</a><a href="#method.bitor" class="anchor"></a><h4 class="code-header">fn <a class="fnname">bitor</a>(self, other: <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>) -&gt; <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h4></section></summary><div class='docblock'>Performs the <code>|</code> operation. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-BitOrAssign%3CReady%3E-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#216-221">source</a><a href="#impl-BitOrAssign%3CReady%3E-for-Ready" class="anchor"></a><h3 class="code-header">impl BitOrAssign&lt;<a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>&gt; for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bitor_assign" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#218-220">source</a><a href="#method.bitor_assign" class="anchor"></a><h4 class="code-header">fn <a class="fnname">bitor_assign</a>(&amp;mut self, other: <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>)</h4></section></summary><div class='docblock'>Performs the <code>|=</code> operation. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#15">source</a><a href="#impl-Clone-for-Ready" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#15">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#241-250">source</a><a href="#impl-Debug-for-Ready" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#242-249">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, fmt: &amp;mut Formatter&lt;'_&gt;) -&gt; Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Ord-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#15">source</a><a href="#impl-Ord-for-Ready" class="anchor"></a><h3 class="code-header">impl Ord for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.cmp" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#15">source</a><a href="#method.cmp" class="anchor"></a><h4 class="code-header">fn <a class="fnname">cmp</a>(&amp;self, other: &amp;<a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>) -&gt; Ordering</h4></section></summary><div class='docblock'>This method returns an [<code>Ordering</code>] between <code>self</code> and <code>other</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.21.0">1.21.0</span><a href="#method.max" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">max</a>(self, other: Self) -&gt; Self</h4></section></summary><div class='docblock'>Compares and returns the maximum of two values. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.min" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.21.0">1.21.0</span><a href="#method.min" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">min</a>(self, other: Self) -&gt; Self</h4></section></summary><div class='docblock'>Compares and returns the minimum of two values. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clamp" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.50.0">1.50.0</span><a href="#method.clamp" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clamp</a>(self, min: Self, max: Self) -&gt; Self<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: PartialOrd&lt;Self&gt;,</span></h4></section></summary><div class='docblock'>Restrict a value to a certain interval. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CReady%3E-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#15">source</a><a href="#impl-PartialEq%3CReady%3E-for-Ready" class="anchor"></a><h3 class="code-header">impl PartialEq&lt;<a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>&gt; for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#15">source</a><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a class="fnname">eq</a>(&amp;self, other: &amp;<a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>) -&gt; bool</h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.ne" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">ne</a>(&amp;self, other: &amp;Rhs) -&gt; bool</h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
sufficient, and should not be overridden without very good reason. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialOrd%3CReady%3E-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#15">source</a><a href="#impl-PartialOrd%3CReady%3E-for-Ready" class="anchor"></a><h3 class="code-header">impl PartialOrd&lt;<a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>&gt; for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.partial_cmp" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#15">source</a><a href="#method.partial_cmp" class="anchor"></a><h4 class="code-header">fn <a class="fnname">partial_cmp</a>(&amp;self, other: &amp;<a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>) -&gt; Option&lt;Ordering&gt;</h4></section></summary><div class='docblock'>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lt" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.lt" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">lt</a>(&amp;self, other: &amp;Rhs) -&gt; bool</h4></section></summary><div class='docblock'>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code>&lt;</code> operator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.le" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.le" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">le</a>(&amp;self, other: &amp;Rhs) -&gt; bool</h4></section></summary><div class='docblock'>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>&lt;=</code>
operator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.gt" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.gt" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">gt</a>(&amp;self, other: &amp;Rhs) -&gt; bool</h4></section></summary><div class='docblock'>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>&gt;</code> operator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ge" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.ge" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">ge</a>(&amp;self, other: &amp;Rhs) -&gt; bool</h4></section></summary><div class='docblock'>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>&gt;=</code>
operator. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Sub%3CReady%3E-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#232-239">source</a><a href="#impl-Sub%3CReady%3E-for-Ready" class="anchor"></a><h3 class="code-header">impl Sub&lt;<a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>&gt; for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-2" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Output</a> = <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h4></section></summary><div class='docblock'>The resulting type after applying the <code>-</code> operator.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.sub" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#236-238">source</a><a href="#method.sub" class="anchor"></a><h4 class="code-header">fn <a class="fnname">sub</a>(self, other: <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a>) -&gt; <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h4></section></summary><div class='docblock'>Performs the <code>-</code> operation. <a>Read more</a></div></details></div></details><section id="impl-Copy-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#15">source</a><a href="#impl-Copy-for-Ready" class="anchor"></a><h3 class="code-header">impl Copy for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section><section id="impl-Eq-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#15">source</a><a href="#impl-Eq-for-Ready" class="anchor"></a><h3 class="code-header">impl Eq for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section><section id="impl-StructuralEq-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#15">source</a><a href="#impl-StructuralEq-for-Ready" class="anchor"></a><h3 class="code-header">impl StructuralEq for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section><section id="impl-StructuralPartialEq-for-Ready" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/ready.rs.html#15">source</a><a href="#impl-StructuralPartialEq-for-Ready" class="anchor"></a><h3 class="code-header">impl StructuralPartialEq for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Ready" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Ready" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section><section id="impl-Send-for-Ready" class="impl has-srclink"><a href="#impl-Send-for-Ready" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section><section id="impl-Sync-for-Ready" class="impl has-srclink"><a href="#impl-Sync-for-Ready" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section><section id="impl-Unpin-for-Ready" class="impl has-srclink"><a href="#impl-Unpin-for-Ready" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section><section id="impl-UnwindSafe-for-Ready" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Ready" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.Ready.html" title="struct tokio::io::Ready">Ready</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Ready" class="impl has-srclink"><a href="#impl-Any-for-Ready" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Ready" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Ready" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Ready" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Ready" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Ready" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Ready" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Ready" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Ready" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Ready" class="impl has-srclink"><a href="#impl-ToOwned-for-Ready" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; ToOwned for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&amp;self, target: &amp;mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Ready" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Ready" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Ready" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Ready" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>