178 lines
No EOL
19 KiB
HTML
178 lines
No EOL
19 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="API documentation for the Rust `OpenOptions` struct in crate `tokio`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, OpenOptions">
|
||
|
||
<title>tokio::fs::file::OpenOptions - 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="../../../main.css" id="themeStyle">
|
||
<script src="../../../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc struct">
|
||
<!--[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>
|
||
|
||
<p class='location'>Struct OpenOptions</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.read">read</a><a href="#method.write">write</a><a href="#method.append">append</a><a href="#method.truncate">truncate</a><a href="#method.create">create</a><a href="#method.create_new">create_new</a><a href="#method.open">open</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-From%3COpenOptions%3E">From<OpenOptions></a><a href="#impl-Debug">Debug</a><a href="#impl-Clone">Clone</a></div></div><p class='location'><a href='../../index.html'>tokio</a>::<wbr><a href='../index.html'>fs</a>::<wbr><a href='index.html'>file</a></p><script>window.sidebarCurrent = {name: 'OpenOptions', ty: 'struct', 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">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>tokio</a>::<wbr><a href='../index.html'>fs</a>::<wbr><a href='index.html'>file</a>::<wbr><a class="struct" href=''>OpenOptions</a></span><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/tokio_fs/file/open_options.rs.html#17' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct OpenOptions(_);</pre><div class='docblock'><p>Options and flags which can be used to configure how a file is opened.</p>
|
||
<p>This is a specialized version of <a href="https://doc.rust-lang.org/std/fs/struct.OpenOptions.html"><code>std::fs::OpenOptions</code></a> for usage from
|
||
the Tokio runtime.</p>
|
||
<p><code>From<std::fs::OpenOptions></code> is implemented for more advanced configuration
|
||
than the methods provided here.</p>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#19-97' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#32-34' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a blank new set of options ready for configuration.</p>
|
||
<p>All options are initially set to <code>false</code>.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><pre class="rust rust-example-rendered ignore">
|
||
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">fs</span>::<span class="ident">OpenOptions</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">options</span> <span class="op">=</span> <span class="ident">OpenOptions</span>::<span class="ident">new</span>();
|
||
<span class="kw">let</span> <span class="ident">future</span> <span class="op">=</span> <span class="ident">options</span>.<span class="ident">read</span>(<span class="bool-val">true</span>).<span class="ident">open</span>(<span class="string">"foo.txt"</span>);</pre>
|
||
</div><h4 id='method.read' class="method"><span id='read.v' class='invisible'><code>pub fn <a href='#method.read' class='fnname'>read</a>(&mut self, read: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#39-42' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>See the underlying <a href="https://doc.rust-lang.org/std/fs/struct.OpenOptions.html#method.read"><code>read</code></a> call for details.</p>
|
||
</div><h4 id='method.write' class="method"><span id='write.v' class='invisible'><code>pub fn <a href='#method.write' class='fnname'>write</a>(&mut self, write: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#47-50' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>See the underlying <a href="https://doc.rust-lang.org/std/fs/struct.OpenOptions.html#method.write"><code>write</code></a> call for details.</p>
|
||
</div><h4 id='method.append' class="method"><span id='append.v' class='invisible'><code>pub fn <a href='#method.append' class='fnname'>append</a>(&mut self, append: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#55-58' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>See the underlying <a href="https://doc.rust-lang.org/std/fs/struct.OpenOptions.html#method.append"><code>append</code></a> call for details.</p>
|
||
</div><h4 id='method.truncate' class="method"><span id='truncate.v' class='invisible'><code>pub fn <a href='#method.truncate' class='fnname'>truncate</a>(&mut self, truncate: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#63-66' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>See the underlying <a href="https://doc.rust-lang.org/std/fs/struct.OpenOptions.html#method.truncate"><code>truncate</code></a> call for details.</p>
|
||
</div><h4 id='method.create' class="method"><span id='create.v' class='invisible'><code>pub fn <a href='#method.create' class='fnname'>create</a>(&mut self, create: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#71-74' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>See the underlying <a href="https://doc.rust-lang.org/std/fs/struct.OpenOptions.html#method.create"><code>create</code></a> call for details.</p>
|
||
</div><h4 id='method.create_new' class="method"><span id='create_new.v' class='invisible'><code>pub fn <a href='#method.create_new' class='fnname'>create_new</a>(&mut self, create_new: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> &mut <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#79-82' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>See the underlying <a href="https://doc.rust-lang.org/std/fs/struct.OpenOptions.html#method.create_new"><code>create_new</code></a> call for details.</p>
|
||
</div><h4 id='method.open' class="method"><span id='open.v' class='invisible'><code>pub fn <a href='#method.open' class='fnname'>open</a><P>(&self, path: P) -> <a class="struct" href="../../../tokio/fs/file/struct.OpenFuture.html" title="struct tokio::fs::file::OpenFuture">OpenFuture</a><P> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#92-96' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Opens a file at <code>path</code> with the options specified by <code>self</code>.</p>
|
||
<h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1>
|
||
<p><code>OpenOptionsFuture</code> results in an error if called from outside of the
|
||
Tokio runtime or if the underlying <a href="https://doc.rust-lang.org/std/fs/struct.OpenOptions.html#method.open"><code>open</code></a> call results in an error.</p>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-From%3COpenOptions%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.OpenOptions.html" title="struct std::fs::OpenOptions">OpenOptions</a>> for <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code><a href='#impl-From%3COpenOptions%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#99-103' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(options: <a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.OpenOptions.html" title="struct std::fs::OpenOptions">OpenOptions</a>) -> <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#100-102' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#16' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#16' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#16' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../../tokio/fs/file/struct.OpenOptions.html" title="struct tokio::fs::file::OpenOptions">OpenOptions</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/tokio_fs/file/open_options.rs.html#16' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div></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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../../";
|
||
window.currentCrate = "tokio";
|
||
</script>
|
||
<script src="../../../main.js"></script>
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |