rust-analyzer/vfs/loader/trait.Handle.html
github-merge-queue[bot] 0ea917a364 deploy: d048a477dc
2025-09-10 02:41:40 +00:00

15 lines
No EOL
7.9 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Interface for reading and watching files."><title>Handle in vfs::loader - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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-84e720fa.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="vfs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.89.0 (29483883e 2025-08-04)" data-channel="1.89.0" data-search-js="search-92309212.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-4e99c027.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-fd3af306.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../vfs/index.html">vfs</a><span class="version">0.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Handle</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.invalidate" title="invalidate">invalidate</a></li><li><a href="#tymethod.load_sync" title="load_sync">load_sync</a></li><li><a href="#tymethod.set_config" title="set_config">set_config</a></li><li><a href="#tymethod.spawn" title="spawn">spawn</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In vfs::<wbr>loader</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">vfs</a>::<wbr><a href="index.html">loader</a></div><h1>Trait <span class="trait">Handle</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/vfs/loader.rs.html#78-93">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Handle: <a class="trait" href="https://doc.rust-lang.org/1.89.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> {
// Required methods
fn <a href="#tymethod.spawn" class="fn">spawn</a>(sender: <a class="type" href="type.Sender.html" title="type vfs::loader::Sender">Sender</a>) -&gt; Self
<span class="where">where Self: <a class="trait" href="https://doc.rust-lang.org/1.89.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>;
<span class="item-spacer"></span> fn <a href="#tymethod.set_config" class="fn">set_config</a>(&amp;mut self, config: <a class="struct" href="struct.Config.html" title="struct vfs::loader::Config">Config</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.invalidate" class="fn">invalidate</a>(&amp;mut self, path: <a class="struct" href="../struct.AbsPathBuf.html" title="struct vfs::AbsPathBuf">AbsPathBuf</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.load_sync" class="fn">load_sync</a>(&amp;mut self, path: &amp;<a class="struct" href="../struct.AbsPath.html" title="struct vfs::AbsPath">AbsPath</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.89.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.89.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.89.0/std/primitive.u8.html">u8</a>&gt;&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Interface for reading and watching files.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.spawn" class="method"><a class="src rightside" href="../../src/vfs/loader.rs.html#80-82">Source</a><h4 class="code-header">fn <a href="#tymethod.spawn" class="fn">spawn</a>(sender: <a class="type" href="type.Sender.html" title="type vfs::loader::Sender">Sender</a>) -&gt; Self<div class="where">where
Self: <a class="trait" href="https://doc.rust-lang.org/1.89.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Spawn a new handle with the given <code>sender</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.set_config" class="method"><a class="src rightside" href="../../src/vfs/loader.rs.html#85">Source</a><h4 class="code-header">fn <a href="#tymethod.set_config" class="fn">set_config</a>(&amp;mut self, config: <a class="struct" href="struct.Config.html" title="struct vfs::loader::Config">Config</a>)</h4></section></summary><div class="docblock"><p>Set this handles configuration.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.invalidate" class="method"><a class="src rightside" href="../../src/vfs/loader.rs.html#88">Source</a><h4 class="code-header">fn <a href="#tymethod.invalidate" class="fn">invalidate</a>(&amp;mut self, path: <a class="struct" href="../struct.AbsPathBuf.html" title="struct vfs::AbsPathBuf">AbsPathBuf</a>)</h4></section></summary><div class="docblock"><p>The files content at <code>path</code> has been modified, and should be reloaded.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.load_sync" class="method"><a class="src rightside" href="../../src/vfs/loader.rs.html#92">Source</a><h4 class="code-header">fn <a href="#tymethod.load_sync" class="fn">load_sync</a>(&amp;mut self, path: &amp;<a class="struct" href="../struct.AbsPath.html" title="struct vfs::AbsPath">AbsPath</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.89.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.89.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.89.0/std/primitive.u8.html">u8</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Load the content of the given file, returning <a href="https://doc.rust-lang.org/1.89.0/core/option/enum.Option.html#variant.None" title="variant core::option::Option::None"><code>None</code></a> if it does not
exists.</p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/vfs/loader/trait.Handle.js" async></script></section></div></main></body></html>