26 lines
11 KiB
HTML
26 lines
11 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="A collection of methods that do not exist in `proc_macro::Diagnostic` but still useful to have around."><meta name="keywords" content="rust, rustlang, rust-lang, DiagnosticExt"><title>DiagnosticExt in proc_macro_error - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.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">☰</button><a class="sidebar-logo" href="../proc_macro_error/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../proc_macro_error/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">DiagnosticExt</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.span_range_error">span_range_error</a></li><li><a href="#tymethod.span_range_help">span_range_help</a></li><li><a href="#tymethod.span_range_note">span_range_note</a></li><li><a href="#tymethod.spanned_range">spanned_range</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In proc_macro_error</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../proc_macro_error/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">proc_macro_error</a>::<wbr><a class="trait" href="#">DiagnosticExt</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/proc_macro_error/diagnostic.rs.html#34-67">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait DiagnosticExt: Sealed {
|
||
fn <a href="#tymethod.spanned_range" class="fnname">spanned_range</a>(span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error::SpanRange">SpanRange</a>, level: <a class="enum" href="enum.Level.html" title="enum proc_macro_error::Level">Level</a>, message: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.span_range_error" class="fnname">span_range_error</a>(self, span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error::SpanRange">SpanRange</a>, msg: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.span_range_help" class="fnname">span_range_help</a>(self, span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error::SpanRange">SpanRange</a>, msg: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.span_range_note" class="fnname">span_range_note</a>(self, span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error::SpanRange">SpanRange</a>, msg: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self;
|
||
}</code></pre></div><details class="rustdoc-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="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.spanned_range" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/proc_macro_error/diagnostic.rs.html#39">source</a></div><h4 class="code-header">fn <a href="#tymethod.spanned_range" class="fnname">spanned_range</a>(span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error::SpanRange">SpanRange</a>, level: <a class="enum" href="enum.Level.html" title="enum proc_macro_error::Level">Level</a>, message: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self</h4></div></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="rustdoc-toggle" open><summary><div id="tymethod.span_range_error" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/proc_macro_error/diagnostic.rs.html#46">source</a></div><h4 class="code-header">fn <a href="#tymethod.span_range_error" class="fnname">span_range_error</a>(self, span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error::SpanRange">SpanRange</a>, msg: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self</h4></div></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="rustdoc-toggle" open><summary><div id="tymethod.span_range_help" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/proc_macro_error/diagnostic.rs.html#56">source</a></div><h4 class="code-header">fn <a href="#tymethod.span_range_help" class="fnname">span_range_help</a>(self, span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error::SpanRange">SpanRange</a>, msg: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self</h4></div></summary><div class="docblock"><p>Attach a “help” note to your main message, the note will have it’s 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 href="#span">Span</a></h5>
|
||
<p>The span is ignored on stable, the note effectively inherits its parent’s (main message) span</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.span_range_note" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/proc_macro_error/diagnostic.rs.html#66">source</a></div><h4 class="code-header">fn <a href="#tymethod.span_range_note" class="fnname">span_range_note</a>(self, span_range: <a class="struct" href="struct.SpanRange.html" title="struct proc_macro_error::SpanRange">SpanRange</a>, msg: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> Self</h4></div></summary><div class="docblock"><p>Attach a note to your main message, the note will have it’s 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 href="#span-1">Span</a></h5>
|
||
<p>The span is ignored on stable, the note effectively inherits its parent’s (main message) span</p>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><section id="impl-DiagnosticExt-for-Diagnostic" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/proc_macro_error/diagnostic.rs.html#69-96">source</a></span><a href="#impl-DiagnosticExt-for-Diagnostic" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.DiagnosticExt.html" title="trait proc_macro_error::DiagnosticExt">DiagnosticExt</a> for <a class="struct" href="struct.Diagnostic.html" title="struct proc_macro_error::Diagnostic">Diagnostic</a></h3></section></div><script type="text/javascript" src="../implementors/proc_macro_error/diagnostic/trait.DiagnosticExt.js" data-ignore-extern-crates="" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="proc_macro_error" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |