15 lines
10 KiB
HTML
15 lines
10 KiB
HTML
<!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="Async filesystem primitives."><title>async_fs - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="async_fs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png"></head><body class="rustdoc mod crate"><!--[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" title="show sidebar"></button><a class="logo-container" href="../async_fs/index.html"><img src="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../async_fs/index.html"><img src="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" alt="logo"></a><h2><a href="../async_fs/index.html">async_<wbr>fs</a><span class="version">2.1.2</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#implementation" title="Implementation">Implementation</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>async_fs</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/async_fs/lib.rs.html#1-1854">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Async filesystem primitives.</p>
|
|
<p>This crate is an async version of <a href="https://doc.rust-lang.org/1.84.0/std/fs/index.html" title="mod std::fs"><code>std::fs</code></a>.</p>
|
|
<h2 id="implementation"><a class="doc-anchor" href="#implementation">§</a>Implementation</h2>
|
|
<p>This crate uses <a href="https://docs.rs/blocking"><code>blocking</code></a> to offload blocking I/O onto a thread pool.</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<p>Create a new file and write some bytes to it:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>async_fs::File;
|
|
<span class="kw">use </span>futures_lite::io::AsyncWriteExt;
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>file = File::create(<span class="string">"a.txt"</span>).<span class="kw">await</span><span class="question-mark">?</span>;
|
|
file.write_all(<span class="string">b"Hello, world!"</span>).<span class="kw">await</span><span class="question-mark">?</span>;
|
|
file.flush().<span class="kw">await</span><span class="question-mark">?</span>;</code></pre></div>
|
|
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.FileType"><code>pub use std::fs::<a class="struct" href="https://doc.rust-lang.org/1.84.0/std/fs/struct.FileType.html" title="struct std::fs::FileType">FileType</a>;</code></div></li><li><div class="item-name" id="reexport.Metadata"><code>pub use std::fs::<a class="struct" href="https://doc.rust-lang.org/1.84.0/std/fs/struct.Metadata.html" title="struct std::fs::Metadata">Metadata</a>;</code></div></li><li><div class="item-name" id="reexport.Permissions"><code>pub use std::fs::<a class="struct" href="https://doc.rust-lang.org/1.84.0/std/fs/struct.Permissions.html" title="struct std::fs::Permissions">Permissions</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="unix/index.html" title="mod async_fs::unix">unix</a></div><div class="desc docblock-short">Unix-specific extensions.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.DirBuilder.html" title="struct async_fs::DirBuilder">DirBuilder</a></div><div class="desc docblock-short">A builder for creating directories with configurable options.</div></li><li><div class="item-name"><a class="struct" href="struct.DirEntry.html" title="struct async_fs::DirEntry">DirEntry</a></div><div class="desc docblock-short">An entry in a directory.</div></li><li><div class="item-name"><a class="struct" href="struct.File.html" title="struct async_fs::File">File</a></div><div class="desc docblock-short">An open file on the filesystem.</div></li><li><div class="item-name"><a class="struct" href="struct.OpenOptions.html" title="struct async_fs::OpenOptions">Open<wbr>Options</a></div><div class="desc docblock-short">A builder for opening files with configurable options.</div></li><li><div class="item-name"><a class="struct" href="struct.ReadDir.html" title="struct async_fs::ReadDir">ReadDir</a></div><div class="desc docblock-short">A stream of entries in a directory.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.canonicalize.html" title="fn async_fs::canonicalize">canonicalize</a></div><div class="desc docblock-short">Returns the canonical form of a path.</div></li><li><div class="item-name"><a class="fn" href="fn.copy.html" title="fn async_fs::copy">copy</a></div><div class="desc docblock-short">Copies a file to a new location.</div></li><li><div class="item-name"><a class="fn" href="fn.create_dir.html" title="fn async_fs::create_dir">create_<wbr>dir</a></div><div class="desc docblock-short">Creates a new, empty directory at the provided path</div></li><li><div class="item-name"><a class="fn" href="fn.create_dir_all.html" title="fn async_fs::create_dir_all">create_<wbr>dir_<wbr>all</a></div><div class="desc docblock-short">Recursively create a directory and all of its parent components if they
|
|
are missing.</div></li><li><div class="item-name"><a class="fn" href="fn.hard_link.html" title="fn async_fs::hard_link">hard_<wbr>link</a></div><div class="desc docblock-short">Creates a hard link on the filesystem.</div></li><li><div class="item-name"><a class="fn" href="fn.metadata.html" title="fn async_fs::metadata">metadata</a></div><div class="desc docblock-short">Reads metadata for a path.</div></li><li><div class="item-name"><a class="fn" href="fn.read.html" title="fn async_fs::read">read</a></div><div class="desc docblock-short">Reads the entire contents of a file as raw bytes.</div></li><li><div class="item-name"><a class="fn" href="fn.read_dir.html" title="fn async_fs::read_dir">read_<wbr>dir</a></div><div class="desc docblock-short">Returns a stream of entries in a directory.</div></li><li><div class="item-name"><a class="fn" href="fn.read_link.html" title="fn async_fs::read_link">read_<wbr>link</a></div><div class="desc docblock-short">Reads a symbolic link and returns the path it points to.</div></li><li><div class="item-name"><a class="fn" href="fn.read_to_string.html" title="fn async_fs::read_to_string">read_<wbr>to_<wbr>string</a></div><div class="desc docblock-short">Reads the entire contents of a file as a string.</div></li><li><div class="item-name"><a class="fn" href="fn.remove_dir.html" title="fn async_fs::remove_dir">remove_<wbr>dir</a></div><div class="desc docblock-short">Removes an empty directory.</div></li><li><div class="item-name"><a class="fn" href="fn.remove_dir_all.html" title="fn async_fs::remove_dir_all">remove_<wbr>dir_<wbr>all</a></div><div class="desc docblock-short">Removes a directory and all of its contents.</div></li><li><div class="item-name"><a class="fn" href="fn.remove_file.html" title="fn async_fs::remove_file">remove_<wbr>file</a></div><div class="desc docblock-short">Removes a file.</div></li><li><div class="item-name"><a class="fn" href="fn.rename.html" title="fn async_fs::rename">rename</a></div><div class="desc docblock-short">Renames a file or directory to a new location.</div></li><li><div class="item-name"><a class="fn" href="fn.set_permissions.html" title="fn async_fs::set_permissions">set_<wbr>permissions</a></div><div class="desc docblock-short">Changes the permissions of a file or directory.</div></li><li><div class="item-name"><a class="fn" href="fn.symlink_metadata.html" title="fn async_fs::symlink_metadata">symlink_<wbr>metadata</a></div><div class="desc docblock-short">Reads metadata for a path without following symbolic links.</div></li><li><div class="item-name"><a class="fn" href="fn.write.html" title="fn async_fs::write">write</a></div><div class="desc docblock-short">Writes a slice of bytes as the new contents of a file.</div></li></ul></section></div></main></body></html> |