rust-analyzer/base_db/trait.SourceDatabase.html
github-merge-queue[bot] 7299742b50 deploy: 0ac65592a8
2025-07-06 09:22:07 +00:00

46 lines
No EOL
12 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 `SourceDatabase` trait in crate `base_db`."><title>SourceDatabase in base_db - 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-1a91846b.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="base_db" data-themes="" data-resource-suffix="" data-rustdoc-version="1.88.0 (6b00bc388 2025-06-23)" data-channel="1.88.0" data-search-js="search-f7877310.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-7ef8a74a.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.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="../base_db/index.html">base_db</a><span class="version">0.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Source<wbr>Database</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.file_source_root" title="file_source_root">file_source_root</a></li><li><a href="#tymethod.file_text" title="file_text">file_text</a></li><li><a href="#tymethod.set_file_source_root_with_durability" title="set_file_source_root_with_durability">set_file_source_root_with_durability</a></li><li><a href="#tymethod.set_file_text" title="set_file_text">set_file_text</a></li><li><a href="#tymethod.set_file_text_with_durability" title="set_file_text_with_durability">set_file_text_with_durability</a></li><li><a href="#tymethod.set_source_root_with_durability" title="set_source_root_with_durability">set_source_root_with_durability</a></li><li><a href="#tymethod.source_root" title="source_root">source_root</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.resolve_path" title="resolve_path">resolve_path</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate base_<wbr>db</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"><div class="rustdoc-breadcrumbs"><a href="index.html">base_db</a></div><h1>Trait <span class="trait">SourceDatabase</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/base_db/lib.rs.html#286-328">Source</a> </span></div><pre class="rust item-decl"><code>pub trait SourceDatabase: Database {
// Required methods
fn <a href="#tymethod.file_text" class="fn">file_text</a>(&amp;self, file_id: <a class="struct" href="struct.FileId.html" title="struct base_db::FileId">FileId</a>) -&gt; <a class="struct" href="struct.FileText.html" title="struct base_db::FileText">FileText</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.set_file_text" class="fn">set_file_text</a>(&amp;mut self, file_id: <a class="struct" href="struct.FileId.html" title="struct base_db::FileId">FileId</a>, text: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.88.0/std/primitive.str.html">str</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.set_file_text_with_durability" class="fn">set_file_text_with_durability</a>(
&amp;mut self,
file_id: <a class="struct" href="struct.FileId.html" title="struct base_db::FileId">FileId</a>,
text: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.88.0/std/primitive.str.html">str</a>,
durability: Durability,
);
<span class="item-spacer"></span> fn <a href="#tymethod.source_root" class="fn">source_root</a>(&amp;self, id: <a class="struct" href="struct.SourceRootId.html" title="struct base_db::SourceRootId">SourceRootId</a>) -&gt; <a class="struct" href="struct.SourceRootInput.html" title="struct base_db::SourceRootInput">SourceRootInput</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.file_source_root" class="fn">file_source_root</a>(&amp;self, id: <a class="struct" href="struct.FileId.html" title="struct base_db::FileId">FileId</a>) -&gt; <a class="struct" href="struct.FileSourceRootInput.html" title="struct base_db::FileSourceRootInput">FileSourceRootInput</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.set_file_source_root_with_durability" class="fn">set_file_source_root_with_durability</a>(
&amp;mut self,
id: <a class="struct" href="struct.FileId.html" title="struct base_db::FileId">FileId</a>,
source_root_id: <a class="struct" href="struct.SourceRootId.html" title="struct base_db::SourceRootId">SourceRootId</a>,
durability: Durability,
);
<span class="item-spacer"></span> fn <a href="#tymethod.set_source_root_with_durability" class="fn">set_source_root_with_durability</a>(
&amp;mut self,
source_root_id: <a class="struct" href="struct.SourceRootId.html" title="struct base_db::SourceRootId">SourceRootId</a>,
source_root: Arc&lt;<a class="struct" href="struct.SourceRoot.html" title="struct base_db::SourceRoot">SourceRoot</a>&gt;,
durability: Durability,
);
// Provided method
fn <a href="#method.resolve_path" class="fn">resolve_path</a>(&amp;self, path: <a class="struct" href="struct.AnchoredPath.html" title="struct base_db::AnchoredPath">AnchoredPath</a>&lt;'_&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.88.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.FileId.html" title="struct base_db::FileId">FileId</a>&gt; { ... }
}</code></pre><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.file_text" class="method"><a class="src rightside" href="../src/base_db/lib.rs.html#288">Source</a><h4 class="code-header">fn <a href="#tymethod.file_text" class="fn">file_text</a>(&amp;self, file_id: <a class="struct" href="struct.FileId.html" title="struct base_db::FileId">FileId</a>) -&gt; <a class="struct" href="struct.FileText.html" title="struct base_db::FileText">FileText</a></h4></section></summary><div class="docblock"><p>Text of the file.</p>
</div></details><section id="tymethod.set_file_text" class="method"><a class="src rightside" href="../src/base_db/lib.rs.html#290">Source</a><h4 class="code-header">fn <a href="#tymethod.set_file_text" class="fn">set_file_text</a>(&amp;mut self, file_id: <a class="struct" href="struct.FileId.html" title="struct base_db::FileId">FileId</a>, text: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.88.0/std/primitive.str.html">str</a>)</h4></section><section id="tymethod.set_file_text_with_durability" class="method"><a class="src rightside" href="../src/base_db/lib.rs.html#292-297">Source</a><h4 class="code-header">fn <a href="#tymethod.set_file_text_with_durability" class="fn">set_file_text_with_durability</a>(
&amp;mut self,
file_id: <a class="struct" href="struct.FileId.html" title="struct base_db::FileId">FileId</a>,
text: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.88.0/std/primitive.str.html">str</a>,
durability: Durability,
)</h4></section><details class="toggle method-toggle" open><summary><section id="tymethod.source_root" class="method"><a class="src rightside" href="../src/base_db/lib.rs.html#300">Source</a><h4 class="code-header">fn <a href="#tymethod.source_root" class="fn">source_root</a>(&amp;self, id: <a class="struct" href="struct.SourceRootId.html" title="struct base_db::SourceRootId">SourceRootId</a>) -&gt; <a class="struct" href="struct.SourceRootInput.html" title="struct base_db::SourceRootInput">SourceRootInput</a></h4></section></summary><div class="docblock"><p>Contents of the source root.</p>
</div></details><section id="tymethod.file_source_root" class="method"><a class="src rightside" href="../src/base_db/lib.rs.html#302">Source</a><h4 class="code-header">fn <a href="#tymethod.file_source_root" class="fn">file_source_root</a>(&amp;self, id: <a class="struct" href="struct.FileId.html" title="struct base_db::FileId">FileId</a>) -&gt; <a class="struct" href="struct.FileSourceRootInput.html" title="struct base_db::FileSourceRootInput">FileSourceRootInput</a></h4></section><section id="tymethod.set_file_source_root_with_durability" class="method"><a class="src rightside" href="../src/base_db/lib.rs.html#304-309">Source</a><h4 class="code-header">fn <a href="#tymethod.set_file_source_root_with_durability" class="fn">set_file_source_root_with_durability</a>(
&amp;mut self,
id: <a class="struct" href="struct.FileId.html" title="struct base_db::FileId">FileId</a>,
source_root_id: <a class="struct" href="struct.SourceRootId.html" title="struct base_db::SourceRootId">SourceRootId</a>,
durability: Durability,
)</h4></section><details class="toggle method-toggle" open><summary><section id="tymethod.set_source_root_with_durability" class="method"><a class="src rightside" href="../src/base_db/lib.rs.html#312-317">Source</a><h4 class="code-header">fn <a href="#tymethod.set_source_root_with_durability" class="fn">set_source_root_with_durability</a>(
&amp;mut self,
source_root_id: <a class="struct" href="struct.SourceRootId.html" title="struct base_db::SourceRootId">SourceRootId</a>,
source_root: Arc&lt;<a class="struct" href="struct.SourceRoot.html" title="struct base_db::SourceRoot">SourceRoot</a>&gt;,
durability: Durability,
)</h4></section></summary><div class="docblock"><p>Source root of the file.</p>
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><section id="method.resolve_path" class="method"><a class="src rightside" href="../src/base_db/lib.rs.html#319-324">Source</a><h4 class="code-header">fn <a href="#method.resolve_path" class="fn">resolve_path</a>(&amp;self, path: <a class="struct" href="struct.AnchoredPath.html" title="struct base_db::AnchoredPath">AnchoredPath</a>&lt;'_&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.88.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.FileId.html" title="struct base_db::FileId">FileId</a>&gt;</h4></section></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/base_db/trait.SourceDatabase.js" async></script></section></div></main></body></html>