mirror of
https://github.com/NotAShelf/mpvrc.git
synced 2026-04-17 00:13:48 +00:00
23 lines
No EOL
5.9 KiB
HTML
23 lines
No EOL
5.9 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="Create a new spooled temporary file."><title>spooled_tempfile in tempfile - 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="tempfile" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.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://www.rust-lang.org/favicon.ico"></head><body class="rustdoc fn"><!--[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="../tempfile/index.html"><img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../tempfile/index.html"><img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png" alt="logo"></a><h2><a href="../tempfile/index.html">tempfile</a><span class="version">3.14.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">spooled_<wbr>tempfile</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#security" title="Security">Security</a></li><li><a href="#resource-leaking" title="Resource Leaking">Resource Leaking</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate tempfile</a></h2></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"><span class="rustdoc-breadcrumbs"><a href="index.html">tempfile</a></span><h1>Function <span class="fn">spooled_tempfile</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/tempfile/spooled.rs.html#54-56">Source</a> </span></div><pre class="rust item-decl"><code>pub fn spooled_tempfile(max_size: <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.usize.html">usize</a>) -> <a class="struct" href="struct.SpooledTempFile.html" title="struct tempfile::SpooledTempFile">SpooledTempFile</a> <a href="#" class="tooltip" data-notable-ty="SpooledTempFile">ⓘ</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Create a new spooled temporary file.</p>
|
||
<h2 id="security"><a class="doc-anchor" href="#security">§</a>Security</h2>
|
||
<p>This variant is secure/reliable in the presence of a pathological temporary
|
||
file cleaner.</p>
|
||
<h2 id="resource-leaking"><a class="doc-anchor" href="#resource-leaking">§</a>Resource Leaking</h2>
|
||
<p>The temporary file will be automatically removed by the OS when the last
|
||
handle to it is closed. This doesn’t rely on Rust destructors being run, so
|
||
will (almost) never fail to clean up the temporary file.</p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tempfile::spooled_tempfile;
|
||
<span class="kw">use </span>std::io::Write;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>file = spooled_tempfile(<span class="number">15</span>);
|
||
|
||
<span class="macro">writeln!</span>(file, <span class="string">"short line"</span>)<span class="question-mark">?</span>;
|
||
<span class="macro">assert!</span>(!file.is_rolled());
|
||
|
||
<span class="comment">// as a result of this write call, the size of the data will exceed
|
||
// `max_size` (15), so it will be written to a temporary file on disk,
|
||
// and the in-memory buffer will be dropped
|
||
</span><span class="macro">writeln!</span>(file, <span class="string">"marvin gardens"</span>)<span class="question-mark">?</span>;
|
||
<span class="macro">assert!</span>(file.is_rolled());</code></pre></div>
|
||
</div></details><script type="text/json" id="notable-traits-data">{"SpooledTempFile":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.SpooledTempFile.html\" title=\"struct tempfile::SpooledTempFile\">SpooledTempFile</a></code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.1/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"struct.SpooledTempFile.html\" title=\"struct tempfile::SpooledTempFile\">SpooledTempFile</a></div><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"struct.SpooledTempFile.html\" title=\"struct tempfile::SpooledTempFile\">SpooledTempFile</a></div>"}</script></section></div></main></body></html> |