rtic/dev/api/proc_macro_error2/trait.DiagnosticExt.html
2024-12-06 13:35:18 +00:00

31 lines
No EOL
10 KiB
HTML
Raw 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="A collection of methods that do not exist in `proc_macro::Diagnostic` but still useful to have around."><title>DiagnosticExt in proc_macro_error2 - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="proc_macro_error2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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="../proc_macro_error2/index.html">proc_<wbr>macro_<wbr>error2</a><span class="version">2.0.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Diagnostic<wbr>Ext</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.span_range_error" title="span_range_error">span_range_error</a></li><li><a href="#tymethod.span_range_help" title="span_range_help">span_range_help</a></li><li><a href="#tymethod.span_range_note" title="span_range_note">span_range_note</a></li><li><a href="#tymethod.spanned_range" title="spanned_range">spanned_range</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate proc_<wbr>macro_<wbr>error2</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">proc_macro_error2</a></span><h1>Trait <span class="trait">DiagnosticExt</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/proc_macro_error2/diagnostic.rs.html#34-70">source</a> </span></div><pre class="rust item-decl"><code>pub trait DiagnosticExt: Sealed {
// Required methods
fn <a href="#tymethod.spanned_range" class="fn">spanned_range</a>(
span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error2::SpanRange">SpanRange</a>,
level: <a class="enum" href="enum.Level.html" title="enum proc_macro_error2::Level">Level</a>,
message: <a class="struct" href="https://doc.rust-lang.org/1.83.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.span_range_error" class="fn">span_range_error</a>(self, span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error2::SpanRange">SpanRange</a>, msg: <a class="struct" href="https://doc.rust-lang.org/1.83.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.span_range_help" class="fn">span_range_help</a>(self, span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error2::SpanRange">SpanRange</a>, msg: <a class="struct" href="https://doc.rust-lang.org/1.83.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.span_range_note" class="fn">span_range_note</a>(self, span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error2::SpanRange">SpanRange</a>, msg: <a class="struct" href="https://doc.rust-lang.org/1.83.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; Self;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A collection of methods that do not exist in <code>proc_macro::Diagnostic</code>
but still useful to have around.</p>
<p>This trait is sealed and cannot be implemented outside of <code>proc_macro_error</code>.</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.spanned_range" class="method"><a class="src rightside" href="../src/proc_macro_error2/diagnostic.rs.html#39">source</a><h4 class="code-header">fn <a href="#tymethod.spanned_range" class="fn">spanned_range</a>(span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error2::SpanRange">SpanRange</a>, level: <a class="enum" href="enum.Level.html" title="enum proc_macro_error2::Level">Level</a>, message: <a class="struct" href="https://doc.rust-lang.org/1.83.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a new diagnostic message that points to the <code>span_range</code>.</p>
<p>This function is the same as <code>Diagnostic::spanned</code> but produces considerably
better error messages for multi-token spans on stable.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.span_range_error" class="method"><a class="src rightside" href="../src/proc_macro_error2/diagnostic.rs.html#47">source</a><h4 class="code-header">fn <a href="#tymethod.span_range_error" class="fn">span_range_error</a>(self, span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error2::SpanRange">SpanRange</a>, msg: <a class="struct" href="https://doc.rust-lang.org/1.83.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Add another error message to self such that it will be emitted right after
the main message.</p>
<p>This function is the same as <code>Diagnostic::span_error</code> but produces considerably
better error messages for multi-token spans on stable.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.span_range_help" class="method"><a class="src rightside" href="../src/proc_macro_error2/diagnostic.rs.html#58">source</a><h4 class="code-header">fn <a href="#tymethod.span_range_help" class="fn">span_range_help</a>(self, span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error2::SpanRange">SpanRange</a>, msg: <a class="struct" href="https://doc.rust-lang.org/1.83.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Attach a “help” note to your main message, the note will have its own span on nightly.</p>
<p>This function is the same as <code>Diagnostic::span_help</code> but produces considerably
better error messages for multi-token spans on stable.</p>
<h5 id="span"><a class="doc-anchor" href="#span">§</a>Span</h5>
<p>The span is ignored on stable, the note effectively inherits its parents (main message) span</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.span_range_note" class="method"><a class="src rightside" href="../src/proc_macro_error2/diagnostic.rs.html#69">source</a><h4 class="code-header">fn <a href="#tymethod.span_range_note" class="fn">span_range_note</a>(self, span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error2::SpanRange">SpanRange</a>, msg: <a class="struct" href="https://doc.rust-lang.org/1.83.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Attach a note to your main message, the note will have its own span on nightly.</p>
<p>This function is the same as <code>Diagnostic::span_note</code> but produces considerably
better error messages for multi-token spans on stable.</p>
<h5 id="span-1"><a class="doc-anchor" href="#span-1">§</a>Span</h5>
<p>The span is ignored on stable, the note effectively inherits its parents (main message) span</p>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.83.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-DiagnosticExt-for-Diagnostic" class="impl"><a class="src rightside" href="../src/proc_macro_error2/diagnostic.rs.html#72-99">source</a><a href="#impl-DiagnosticExt-for-Diagnostic" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.DiagnosticExt.html" title="trait proc_macro_error2::DiagnosticExt">DiagnosticExt</a> for <a class="struct" href="struct.Diagnostic.html" title="struct proc_macro_error2::Diagnostic">Diagnostic</a></h3></section></div><script src="../trait.impl/proc_macro_error2/diagnostic/trait.DiagnosticExt.js" async></script></section></div></main></body></html>