mirror of
https://github.com/rust-lang/rust-analyzer.git
synced 2025-12-27 16:07:46 +00:00
18 lines
16 KiB
HTML
18 lines
16 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 `HasDocs` trait in crate `ide_db`."><title>HasDocs in ide_db::documentation - 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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="ide_db" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.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]--><rustdoc-topbar><h2><a href="#">HasDocs</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../ide_db/index.html">ide_db</a><span class="version">0.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">HasDocs</a></h2><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.docs" title="docs">docs</a></li><li><a href="#method.docs_with_rangemap" title="docs_with_rangemap">docs_with_rangemap</a></li><li><a href="#method.resolve_doc_path" title="resolve_doc_path">resolve_doc_path</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-HasDocs-for-Adt" title="Adt">Adt</a></li><li><a href="#impl-HasDocs-for-AssocItem" title="AssocItem">AssocItem</a></li><li><a href="#impl-HasDocs-for-Const" title="Const">Const</a></li><li><a href="#impl-HasDocs-for-Crate" title="Crate">Crate</a></li><li><a href="#impl-HasDocs-for-Enum" title="Enum">Enum</a></li><li><a href="#impl-HasDocs-for-ExternCrateDecl" title="ExternCrateDecl">ExternCrateDecl</a></li><li><a href="#impl-HasDocs-for-Field" title="Field">Field</a></li><li><a href="#impl-HasDocs-for-Function" title="Function">Function</a></li><li><a href="#impl-HasDocs-for-Impl" title="Impl">Impl</a></li><li><a href="#impl-HasDocs-for-Macro" title="Macro">Macro</a></li><li><a href="#impl-HasDocs-for-Module" title="Module">Module</a></li><li><a href="#impl-HasDocs-for-Static" title="Static">Static</a></li><li><a href="#impl-HasDocs-for-Struct" title="Struct">Struct</a></li><li><a href="#impl-HasDocs-for-Trait" title="Trait">Trait</a></li><li><a href="#impl-HasDocs-for-TypeAlias" title="TypeAlias">TypeAlias</a></li><li><a href="#impl-HasDocs-for-Union" title="Union">Union</a></li><li><a href="#impl-HasDocs-for-Variant" title="Variant">Variant</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In ide_<wbr>db::<wbr>documentation</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">ide_db</a>::<wbr><a href="index.html">documentation</a></div><h1>Trait <span class="trait">HasDocs</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/ide_db/documentation.rs.html#32-52">Source</a> </span></div><pre class="rust item-decl"><code>pub trait HasDocs: HasAttrs + <a class="trait" href="https://doc.rust-lang.org/1.92.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> {
|
|
// Provided methods
|
|
fn <a href="#method.docs" class="fn">docs</a>(self, db: &dyn HirDatabase) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.Documentation.html" title="struct ide_db::documentation::Documentation">Documentation</a><'_>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.docs_with_rangemap" class="fn">docs_with_rangemap</a>(self, db: &dyn HirDatabase) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/1.92.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'_, Docs>> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.resolve_doc_path" class="fn">resolve_doc_path</a>(
|
|
self,
|
|
db: &dyn HirDatabase,
|
|
link: &<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.str.html">str</a>,
|
|
ns: <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Namespace>,
|
|
is_inner_doc: IsInnerDoc,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><DocLinkDef> { ... }
|
|
}</code></pre><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><section id="method.docs" class="method"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#33-39">Source</a><h4 class="code-header">fn <a href="#method.docs" class="fn">docs</a>(self, db: &dyn HirDatabase) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.Documentation.html" title="struct ide_db::documentation::Documentation">Documentation</a><'_>></h4></section><section id="method.docs_with_rangemap" class="method"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#40-42">Source</a><h4 class="code-header">fn <a href="#method.docs_with_rangemap" class="fn">docs_with_rangemap</a>(self, db: &dyn HirDatabase) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/1.92.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'_, Docs>></h4></section><section id="method.resolve_doc_path" class="method"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#43-51">Source</a><h4 class="code-header">fn <a href="#method.resolve_doc_path" class="fn">resolve_doc_path</a>(
|
|
self,
|
|
db: &dyn HirDatabase,
|
|
link: &<a class="primitive" href="https://doc.rust-lang.org/1.92.0/std/primitive.str.html">str</a>,
|
|
ns: <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Namespace>,
|
|
is_inner_doc: IsInnerDoc,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><DocLinkDef></h4></section></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.92.0/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><section id="impl-HasDocs-for-Adt" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Adt" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Adt</h3></section><section id="impl-HasDocs-for-AssocItem" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-AssocItem" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for AssocItem</h3></section><section id="impl-HasDocs-for-Const" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Const" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Const</h3></section><section id="impl-HasDocs-for-Crate" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Crate" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Crate</h3></section><section id="impl-HasDocs-for-Enum" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Enum" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Enum</h3></section><details class="toggle implementors-toggle"><summary><section id="impl-HasDocs-for-ExternCrateDecl" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#65-100">Source</a><a href="#impl-HasDocs-for-ExternCrateDecl" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for ExternCrateDecl</h3></section></summary><div class="impl-items"><section id="method.docs-1" class="method trait-impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#66-84">Source</a><a href="#method.docs-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.docs" class="fn">docs</a>(self, db: &dyn HirDatabase) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.Documentation.html" title="struct ide_db::documentation::Documentation">Documentation</a><'_>></h4></section><section id="method.docs_with_rangemap-1" class="method trait-impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#86-99">Source</a><a href="#method.docs_with_rangemap-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.docs_with_rangemap" class="fn">docs_with_rangemap</a>(self, db: &dyn HirDatabase) -> <a class="enum" href="https://doc.rust-lang.org/1.92.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/1.92.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'_, Docs>></h4></section></div></details><section id="impl-HasDocs-for-Field" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Field" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Field</h3></section><section id="impl-HasDocs-for-Function" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Function" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Function</h3></section><section id="impl-HasDocs-for-Impl" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Impl" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Impl</h3></section><section id="impl-HasDocs-for-Macro" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Macro" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Macro</h3></section><section id="impl-HasDocs-for-Module" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Module" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Module</h3></section><section id="impl-HasDocs-for-Static" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Static" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Static</h3></section><section id="impl-HasDocs-for-Struct" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Struct" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Struct</h3></section><section id="impl-HasDocs-for-Trait" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Trait" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Trait</h3></section><section id="impl-HasDocs-for-TypeAlias" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-TypeAlias" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for TypeAlias</h3></section><section id="impl-HasDocs-for-Union" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Union" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Union</h3></section><section id="impl-HasDocs-for-Variant" class="impl"><a class="src rightside" href="../../src/ide_db/documentation.rs.html#60-63">Source</a><a href="#impl-HasDocs-for-Variant" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocs.html" title="trait ide_db::documentation::HasDocs">HasDocs</a> for Variant</h3></section><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/ide_db/documentation/trait.HasDocs.js" data-ignore-extern-crates="hir" async></script></section></div></main></body></html> |