| <!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/tokio-1.28.2/src/fs/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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="../../../tokio/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="../../../tokio/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> |
| </pre><pre class="rust"><code><span class="attribute">#![cfg(not(loom))] |
| |
| </span><span class="doccomment">//! Asynchronous file and standard stream adaptation. |
| //! |
| //! This module contains utility methods and adapter types for input/output to |
| //! files or standard streams (`Stdin`, `Stdout`, `Stderr`), and |
| //! filesystem manipulation, for use within (and only within) a Tokio runtime. |
| //! |
| //! Tasks run by *worker* threads should not block, as this could delay |
| //! servicing reactor events. Portable filesystem operations are blocking, |
| //! however. This module offers adapters which use a `blocking` annotation |
| //! to inform the runtime that a blocking operation is required. When |
| //! necessary, this allows the runtime to convert the current thread from a |
| //! *worker* to a *backup* thread, where blocking is acceptable. |
| //! |
| //! ## Usage |
| //! |
| //! Where possible, users should prefer the provided asynchronous-specific |
| //! traits such as [`AsyncRead`], or methods returning a `Future` or `Poll` |
| //! type. Adaptions also extend to traits like `std::io::Read` where methods |
| //! return `std::io::Result`. Be warned that these adapted methods may return |
| //! `std::io::ErrorKind::WouldBlock` if a *worker* thread can not be converted |
| //! to a *backup* thread immediately. |
| //! |
| //! **Warning**: These adapters may create a large number of temporary tasks, |
| //! especially when reading large files. When performing a lot of operations |
| //! in one batch, it may be significantly faster to use [`spawn_blocking`] |
| //! directly: |
| //! |
| //! ``` |
| //! use tokio::fs::File; |
| //! use std::io::{BufReader, BufRead}; |
| //! async fn count_lines(file: File) -> Result<usize, std::io::Error> { |
| //! let file = file.into_std().await; |
| //! tokio::task::spawn_blocking(move || { |
| //! let line_count = BufReader::new(file).lines().count(); |
| //! Ok(line_count) |
| //! }).await? |
| //! } |
| //! ``` |
| //! |
| //! [`spawn_blocking`]: fn@crate::task::spawn_blocking |
| //! [`AsyncRead`]: trait@crate::io::AsyncRead |
| |
| </span><span class="kw">mod </span>canonicalize; |
| <span class="kw">pub use </span><span class="self">self</span>::canonicalize::canonicalize; |
| |
| <span class="kw">mod </span>create_dir; |
| <span class="kw">pub use </span><span class="self">self</span>::create_dir::create_dir; |
| |
| <span class="kw">mod </span>create_dir_all; |
| <span class="kw">pub use </span><span class="self">self</span>::create_dir_all::create_dir_all; |
| |
| <span class="kw">mod </span>dir_builder; |
| <span class="kw">pub use </span><span class="self">self</span>::dir_builder::DirBuilder; |
| |
| <span class="kw">mod </span>file; |
| <span class="kw">pub use </span><span class="self">self</span>::file::File; |
| |
| <span class="kw">mod </span>hard_link; |
| <span class="kw">pub use </span><span class="self">self</span>::hard_link::hard_link; |
| |
| <span class="kw">mod </span>metadata; |
| <span class="kw">pub use </span><span class="self">self</span>::metadata::metadata; |
| |
| <span class="kw">mod </span>open_options; |
| <span class="kw">pub use </span><span class="self">self</span>::open_options::OpenOptions; |
| |
| <span class="kw">mod </span>read; |
| <span class="kw">pub use </span><span class="self">self</span>::read::read; |
| |
| <span class="kw">mod </span>read_dir; |
| <span class="kw">pub use </span><span class="self">self</span>::read_dir::{read_dir, DirEntry, ReadDir}; |
| |
| <span class="kw">mod </span>read_link; |
| <span class="kw">pub use </span><span class="self">self</span>::read_link::read_link; |
| |
| <span class="kw">mod </span>read_to_string; |
| <span class="kw">pub use </span><span class="self">self</span>::read_to_string::read_to_string; |
| |
| <span class="kw">mod </span>remove_dir; |
| <span class="kw">pub use </span><span class="self">self</span>::remove_dir::remove_dir; |
| |
| <span class="kw">mod </span>remove_dir_all; |
| <span class="kw">pub use </span><span class="self">self</span>::remove_dir_all::remove_dir_all; |
| |
| <span class="kw">mod </span>remove_file; |
| <span class="kw">pub use </span><span class="self">self</span>::remove_file::remove_file; |
| |
| <span class="kw">mod </span>rename; |
| <span class="kw">pub use </span><span class="self">self</span>::rename::rename; |
| |
| <span class="kw">mod </span>set_permissions; |
| <span class="kw">pub use </span><span class="self">self</span>::set_permissions::set_permissions; |
| |
| <span class="kw">mod </span>symlink_metadata; |
| <span class="kw">pub use </span><span class="self">self</span>::symlink_metadata::symlink_metadata; |
| |
| <span class="kw">mod </span>write; |
| <span class="kw">pub use </span><span class="self">self</span>::write::write; |
| |
| <span class="kw">mod </span>copy; |
| <span class="kw">pub use </span><span class="self">self</span>::copy::copy; |
| |
| <span class="kw">mod </span>try_exists; |
| <span class="kw">pub use </span><span class="self">self</span>::try_exists::try_exists; |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>mocks; |
| |
| <span class="macro">feature! </span>{ |
| <span class="attribute">#![unix] |
| |
| </span><span class="kw">mod </span>symlink; |
| <span class="kw">pub use </span><span class="self">self</span>::symlink::symlink; |
| } |
| |
| <span class="macro">cfg_windows! </span>{ |
| <span class="kw">mod </span>symlink_dir; |
| <span class="kw">pub use </span><span class="self">self</span>::symlink_dir::symlink_dir; |
| |
| <span class="kw">mod </span>symlink_file; |
| <span class="kw">pub use </span><span class="self">self</span>::symlink_file::symlink_file; |
| } |
| |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[cfg(not(test))] |
| </span><span class="kw">use </span><span class="kw">crate</span>::blocking::spawn_blocking; |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">use </span>mocks::spawn_blocking; |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">async fn </span>asyncify<F, T>(f: F) -> io::Result<T> |
| <span class="kw">where |
| </span>F: FnOnce() -> io::Result<T> + Send + <span class="lifetime">'static</span>, |
| T: Send + <span class="lifetime">'static</span>, |
| { |
| <span class="kw">match </span>spawn_blocking(f).<span class="kw">await </span>{ |
| <span class="prelude-val">Ok</span>(res) => res, |
| <span class="prelude-val">Err</span>(<span class="kw">_</span>) => <span class="prelude-val">Err</span>(io::Error::new( |
| io::ErrorKind::Other, |
| <span class="string">"background task failed"</span>, |
| )), |
| } |
| } |
| </code></pre></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> |
