| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/futures-util-0.3.28/src/io/allow_std.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>allow_std.rs - source</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="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../futures_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../futures_util/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>futures_core::task::{Context, Poll}; |
| <span class="kw">use </span>futures_io::{AsyncBufRead, AsyncRead, AsyncSeek, AsyncWrite, IoSlice, IoSliceMut, SeekFrom}; |
| <span class="kw">use </span>std::pin::Pin; |
| <span class="kw">use </span>std::{fmt, io}; |
| |
| <span class="doccomment">/// A simple wrapper type which allows types which implement only |
| /// implement `std::io::Read` or `std::io::Write` |
| /// to be used in contexts which expect an `AsyncRead` or `AsyncWrite`. |
| /// |
| /// If these types issue an error with the kind `io::ErrorKind::WouldBlock`, |
| /// it is expected that they will notify the current task on readiness. |
| /// Synchronous `std` types should not issue errors of this kind and |
| /// are safe to use in this context. However, using these types with |
| /// `AllowStdIo` will cause the event loop to block, so they should be used |
| /// with care. |
| </span><span class="attribute">#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)] |
| </span><span class="kw">pub struct </span>AllowStdIo<T>(T); |
| |
| <span class="kw">impl</span><T> Unpin <span class="kw">for </span>AllowStdIo<T> {} |
| |
| <span class="macro">macro_rules! </span>try_with_interrupt { |
| (<span class="macro-nonterminal">$e</span>:expr) => { |
| <span class="kw">loop </span>{ |
| <span class="kw">match </span><span class="macro-nonterminal">$e </span>{ |
| <span class="prelude-val">Ok</span>(e) => { |
| <span class="kw">break </span>e; |
| } |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e) <span class="kw">if </span>e.kind() == ::std::io::ErrorKind::Interrupted => { |
| <span class="kw">continue</span>; |
| } |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="kw">return </span>Poll::Ready(<span class="prelude-val">Err</span>(e)); |
| } |
| } |
| } |
| }; |
| } |
| |
| <span class="kw">impl</span><T> AllowStdIo<T> { |
| <span class="doccomment">/// Creates a new `AllowStdIo` from an existing IO object. |
| </span><span class="kw">pub fn </span>new(io: T) -> <span class="self">Self </span>{ |
| <span class="self">Self</span>(io) |
| } |
| |
| <span class="doccomment">/// Returns a reference to the contained IO object. |
| </span><span class="kw">pub fn </span>get_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>T { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0 |
| </span>} |
| |
| <span class="doccomment">/// Returns a mutable reference to the contained IO object. |
| </span><span class="kw">pub fn </span>get_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>T { |
| <span class="kw-2">&mut </span><span class="self">self</span>.<span class="number">0 |
| </span>} |
| |
| <span class="doccomment">/// Consumes self and returns the contained IO object. |
| </span><span class="kw">pub fn </span>into_inner(<span class="self">self</span>) -> T { |
| <span class="self">self</span>.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="kw">impl</span><T> io::Write <span class="kw">for </span>AllowStdIo<T> |
| <span class="kw">where |
| </span>T: io::Write, |
| { |
| <span class="kw">fn </span>write(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.<span class="number">0</span>.write(buf) |
| } |
| <span class="kw">fn </span>write_vectored(<span class="kw-2">&mut </span><span class="self">self</span>, bufs: <span class="kw-2">&</span>[IoSlice<<span class="lifetime">'_</span>>]) -> io::Result<usize> { |
| <span class="self">self</span>.<span class="number">0</span>.write_vectored(bufs) |
| } |
| <span class="kw">fn </span>flush(<span class="kw-2">&mut </span><span class="self">self</span>) -> io::Result<()> { |
| <span class="self">self</span>.<span class="number">0</span>.flush() |
| } |
| <span class="kw">fn </span>write_all(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8]) -> io::Result<()> { |
| <span class="self">self</span>.<span class="number">0</span>.write_all(buf) |
| } |
| <span class="kw">fn </span>write_fmt(<span class="kw-2">&mut </span><span class="self">self</span>, fmt: fmt::Arguments<<span class="lifetime">'_</span>>) -> io::Result<()> { |
| <span class="self">self</span>.<span class="number">0</span>.write_fmt(fmt) |
| } |
| } |
| |
| <span class="kw">impl</span><T> AsyncWrite <span class="kw">for </span>AllowStdIo<T> |
| <span class="kw">where |
| </span>T: io::Write, |
| { |
| <span class="kw">fn </span>poll_write( |
| <span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| <span class="kw">_</span>: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| buf: <span class="kw-2">&</span>[u8], |
| ) -> Poll<io::Result<usize>> { |
| Poll::Ready(<span class="prelude-val">Ok</span>(<span class="macro">try_with_interrupt!</span>(<span class="self">self</span>.<span class="number">0</span>.write(buf)))) |
| } |
| |
| <span class="kw">fn </span>poll_write_vectored( |
| <span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| <span class="kw">_</span>: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| bufs: <span class="kw-2">&</span>[IoSlice<<span class="lifetime">'_</span>>], |
| ) -> Poll<io::Result<usize>> { |
| Poll::Ready(<span class="prelude-val">Ok</span>(<span class="macro">try_with_interrupt!</span>(<span class="self">self</span>.<span class="number">0</span>.write_vectored(bufs)))) |
| } |
| |
| <span class="kw">fn </span>poll_flush(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, <span class="kw">_</span>: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<()>> { |
| <span class="macro">try_with_interrupt!</span>(<span class="self">self</span>.<span class="number">0</span>.flush()); |
| Poll::Ready(<span class="prelude-val">Ok</span>(())) |
| } |
| |
| <span class="kw">fn </span>poll_close(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<()>> { |
| <span class="self">self</span>.poll_flush(cx) |
| } |
| } |
| |
| <span class="kw">impl</span><T> io::Read <span class="kw">for </span>AllowStdIo<T> |
| <span class="kw">where |
| </span>T: io::Read, |
| { |
| <span class="kw">fn </span>read(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.<span class="number">0</span>.read(buf) |
| } |
| <span class="kw">fn </span>read_vectored(<span class="kw-2">&mut </span><span class="self">self</span>, bufs: <span class="kw-2">&mut </span>[IoSliceMut<<span class="lifetime">'_</span>>]) -> io::Result<usize> { |
| <span class="self">self</span>.<span class="number">0</span>.read_vectored(bufs) |
| } |
| <span class="kw">fn </span>read_to_end(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>Vec<u8>) -> io::Result<usize> { |
| <span class="self">self</span>.<span class="number">0</span>.read_to_end(buf) |
| } |
| <span class="kw">fn </span>read_to_string(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>String) -> io::Result<usize> { |
| <span class="self">self</span>.<span class="number">0</span>.read_to_string(buf) |
| } |
| <span class="kw">fn </span>read_exact(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> io::Result<()> { |
| <span class="self">self</span>.<span class="number">0</span>.read_exact(buf) |
| } |
| } |
| |
| <span class="kw">impl</span><T> AsyncRead <span class="kw">for </span>AllowStdIo<T> |
| <span class="kw">where |
| </span>T: io::Read, |
| { |
| <span class="kw">fn </span>poll_read( |
| <span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| <span class="kw">_</span>: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| buf: <span class="kw-2">&mut </span>[u8], |
| ) -> Poll<io::Result<usize>> { |
| Poll::Ready(<span class="prelude-val">Ok</span>(<span class="macro">try_with_interrupt!</span>(<span class="self">self</span>.<span class="number">0</span>.read(buf)))) |
| } |
| |
| <span class="kw">fn </span>poll_read_vectored( |
| <span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| <span class="kw">_</span>: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| bufs: <span class="kw-2">&mut </span>[IoSliceMut<<span class="lifetime">'_</span>>], |
| ) -> Poll<io::Result<usize>> { |
| Poll::Ready(<span class="prelude-val">Ok</span>(<span class="macro">try_with_interrupt!</span>(<span class="self">self</span>.<span class="number">0</span>.read_vectored(bufs)))) |
| } |
| } |
| |
| <span class="kw">impl</span><T> io::Seek <span class="kw">for </span>AllowStdIo<T> |
| <span class="kw">where |
| </span>T: io::Seek, |
| { |
| <span class="kw">fn </span>seek(<span class="kw-2">&mut </span><span class="self">self</span>, pos: SeekFrom) -> io::Result<u64> { |
| <span class="self">self</span>.<span class="number">0</span>.seek(pos) |
| } |
| } |
| |
| <span class="kw">impl</span><T> AsyncSeek <span class="kw">for </span>AllowStdIo<T> |
| <span class="kw">where |
| </span>T: io::Seek, |
| { |
| <span class="kw">fn </span>poll_seek( |
| <span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| <span class="kw">_</span>: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| pos: SeekFrom, |
| ) -> Poll<io::Result<u64>> { |
| Poll::Ready(<span class="prelude-val">Ok</span>(<span class="macro">try_with_interrupt!</span>(<span class="self">self</span>.<span class="number">0</span>.seek(pos)))) |
| } |
| } |
| |
| <span class="kw">impl</span><T> io::BufRead <span class="kw">for </span>AllowStdIo<T> |
| <span class="kw">where |
| </span>T: io::BufRead, |
| { |
| <span class="kw">fn </span>fill_buf(<span class="kw-2">&mut </span><span class="self">self</span>) -> io::Result<<span class="kw-2">&</span>[u8]> { |
| <span class="self">self</span>.<span class="number">0</span>.fill_buf() |
| } |
| <span class="kw">fn </span>consume(<span class="kw-2">&mut </span><span class="self">self</span>, amt: usize) { |
| <span class="self">self</span>.<span class="number">0</span>.consume(amt) |
| } |
| } |
| |
| <span class="kw">impl</span><T> AsyncBufRead <span class="kw">for </span>AllowStdIo<T> |
| <span class="kw">where |
| </span>T: io::BufRead, |
| { |
| <span class="kw">fn </span>poll_fill_buf(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, <span class="kw">_</span>: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<<span class="kw-2">&</span>[u8]>> { |
| <span class="kw">let </span>this: <span class="kw-2">*mut </span><span class="self">Self </span>= <span class="kw-2">&mut *</span><span class="self">self </span><span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>; |
| Poll::Ready(<span class="prelude-val">Ok</span>(<span class="macro">try_with_interrupt!</span>(<span class="kw">unsafe </span>{ <span class="kw-2">&mut *</span>this }.<span class="number">0</span>.fill_buf()))) |
| } |
| |
| <span class="kw">fn </span>consume(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, amt: usize) { |
| <span class="self">self</span>.<span class="number">0</span>.consume(amt) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="futures_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
