<!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 `Diagnostic` struct in crate `proc_macro`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Diagnostic">
<title>proc_macro::Diagnostic - Rust</title>
<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="../dark.css">
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
<script src="../storage.js"></script>
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
<a href='../proc_macro/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'>Struct Diagnostic</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.spanned">spanned</a><a href="#method.span_error">span_error</a><a href="#method.error">error</a><a href="#method.span_warning">span_warning</a><a href="#method.warning">warning</a><a href="#method.span_note">span_note</a><a href="#method.note">note</a><a href="#method.span_help">span_help</a><a href="#method.help">help</a><a href="#method.level">level</a><a href="#method.emit">emit</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='index.html'>proc_macro</a></p><script>window.sidebarCurrent = {name: 'Diagnostic', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>proc_macro</a>::<wbr><a class="struct" href=''>Diagnostic</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version '></span><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>−</span>]
</a>
</span><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#35-40' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Diagnostic { /* fields omitted */ }</pre><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>A structure representing a diagnostic message and associated children
messages.</p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#62-118' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a><T: <a class="trait" href="../core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(level: <a class="enum" href="../proc_macro/enum.Level.html" title="enum proc_macro::Level">Level</a>, message: T) -> <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#65-72' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>Create a new diagnostic with the given <code>level</code> and <code>message</code>.</p>
</div><h4 id='method.spanned' class="method"><span id='spanned.v' class='invisible'><code>pub fn <a href='#method.spanned' class='fnname'>spanned</a><T: <a class="trait" href="../core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(<br> span: <a class="struct" href="../proc_macro/struct.Span.html" title="struct proc_macro::Span">Span</a>, <br> level: <a class="enum" href="../proc_macro/enum.Level.html" title="enum proc_macro::Level">Level</a>, <br> message: T<br>) -> <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#77-84' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>Create a new diagnostic with the given <code>level</code> and <code>message</code> pointing to
the given <code>span</code>.</p>
</div><h4 id='method.span_error' class="method"><span id='span_error.v' class='invisible'><code>pub fn <a href='#method.span_error' class='fnname'>span_error</a><T: <a class="trait" href="../core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, span: <a class="struct" href="../proc_macro/struct.Span.html" title="struct proc_macro::Span">Span</a>, message: T) -> <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#47-50' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>Add a new child diagnostic message to <code>self</code> with the level
identified by this methods name with the given <code>span</code> and <code>message</code>.</p>
</div><h4 id='method.error' class="method"><span id='error.v' class='invisible'><code>pub fn <a href='#method.error' class='fnname'>error</a><T: <a class="trait" href="../core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, message: T) -> <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#55-58' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>Add a new child diagnostic message to <code>self</code> with the level
identified by this method's name with the given <code>message</code>.</p>
</div><h4 id='method.span_warning' class="method"><span id='span_warning.v' class='invisible'><code>pub fn <a href='#method.span_warning' class='fnname'>span_warning</a><T: <a class="trait" href="../core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, span: <a class="struct" href="../proc_macro/struct.Span.html" title="struct proc_macro::Span">Span</a>, message: T) -> <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#47-50' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>Add a new child diagnostic message to <code>self</code> with the level
identified by this methods name with the given <code>span</code> and <code>message</code>.</p>
</div><h4 id='method.warning' class="method"><span id='warning.v' class='invisible'><code>pub fn <a href='#method.warning' class='fnname'>warning</a><T: <a class="trait" href="../core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, message: T) -> <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#55-58' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>Add a new child diagnostic message to <code>self</code> with the level
identified by this method's name with the given <code>message</code>.</p>
</div><h4 id='method.span_note' class="method"><span id='span_note.v' class='invisible'><code>pub fn <a href='#method.span_note' class='fnname'>span_note</a><T: <a class="trait" href="../core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, span: <a class="struct" href="../proc_macro/struct.Span.html" title="struct proc_macro::Span">Span</a>, message: T) -> <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#47-50' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>Add a new child diagnostic message to <code>self</code> with the level
identified by this methods name with the given <code>span</code> and <code>message</code>.</p>
</div><h4 id='method.note' class="method"><span id='note.v' class='invisible'><code>pub fn <a href='#method.note' class='fnname'>note</a><T: <a class="trait" href="../core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, message: T) -> <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#55-58' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>Add a new child diagnostic message to <code>self</code> with the level
identified by this method's name with the given <code>message</code>.</p>
</div><h4 id='method.span_help' class="method"><span id='span_help.v' class='invisible'><code>pub fn <a href='#method.span_help' class='fnname'>span_help</a><T: <a class="trait" href="../core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, span: <a class="struct" href="../proc_macro/struct.Span.html" title="struct proc_macro::Span">Span</a>, message: T) -> <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#47-50' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>Add a new child diagnostic message to <code>self</code> with the level
identified by this methods name with the given <code>span</code> and <code>message</code>.</p>
</div><h4 id='method.help' class="method"><span id='help.v' class='invisible'><code>pub fn <a href='#method.help' class='fnname'>help</a><T: <a class="trait" href="../core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, message: T) -> <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#55-58' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>Add a new child diagnostic message to <code>self</code> with the level
identified by this method's name with the given <code>message</code>.</p>
</div><h4 id='method.level' class="method"><span id='level.v' class='invisible'><code>pub fn <a href='#method.level' class='fnname'>level</a>(&self) -> <a class="enum" href="../proc_macro/enum.Level.html" title="enum proc_macro::Level">Level</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#93-95' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>Returns the diagnostic <code>level</code> for <code>self</code>.</p>
</div><h4 id='method.emit' class="method"><span id='emit.v' class='invisible'><code>pub fn <a href='#method.emit' class='fnname'>emit</a>(self)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#99-117' title='goto source code'>[src]</a></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>proc_macro </code><a href="https://github.com/rust-lang/rust/issues/38356">#38356</a>)</div></div><div class='docblock'><p>Emit the diagnostic.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="../core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#34' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='../core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#34' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="../core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='../core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="../std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='../src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="../core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="../core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../proc_macro/struct.Diagnostic.html" title="struct proc_macro::Diagnostic">Diagnostic</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#34' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='../core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="../core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="../core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro/diagnostic.rs.html#34' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="../core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "proc_macro";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
fdedb3cf2140df9b6d419a2338ab1caa
>
files
>
2750
