14 lines
10 KiB
HTML
14 lines
10 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="This traits expands `Result<T, Into<Diagnostic>>` with some handy shortcuts."><meta name="keywords" content="rust, rustlang, rust-lang, ResultExt"><title>ResultExt 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 src="../crates.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="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../proc_macro_error/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Trait ResultExt</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#associated-types">Associated Types</a></h3><div class="sidebar-links"><a href="#associatedtype.Ok">Ok</a></div><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.expect_or_abort">expect_or_abort</a><a href="#tymethod.unwrap_or_abort">unwrap_or_abort</a></div><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><div class="sidebar-links"><a href="#impl-ResultExt-for-Result%3CT%2C%20E%3E">Result<T, E></a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="index.html">proc_macro_error</a></h2><div id="sidebar-vars" data-name="ResultExt" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></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.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">proc_macro_error</a>::<wbr><a class="trait" href="#">ResultExt</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><span class="out-of-band"><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_error/lib.rs.html#358-369" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait ResultExt {
|
||
type <a href="#associatedtype.Ok" class="associatedtype">Ok</a>;
|
||
fn <a href="#tymethod.unwrap_or_abort" class="fnname">unwrap_or_abort</a>(self) -> Self::<a class="associatedtype" href="trait.ResultExt.html#associatedtype.Ok" title="type proc_macro_error::ResultExt::Ok">Ok</a>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.expect_or_abort" class="fnname">expect_or_abort</a>(self, msg: &<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.str.html">str</a>) -> Self::<a class="associatedtype" href="trait.ResultExt.html#associatedtype.Ok" title="type proc_macro_error::ResultExt::Ok">Ok</a>;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This traits expands <code>Result<T, Into<Diagnostic>></code> with some handy shortcuts.</p>
|
||
</div></details><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><div id="associatedtype.Ok" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/proc_macro_error/lib.rs.html#359" title="goto source code">[src]</a></div><h4 class="code-header">type <a href="#associatedtype.Ok" class="associatedtype">Ok</a></h4></div></div><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.unwrap_or_abort" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/proc_macro_error/lib.rs.html#363" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.unwrap_or_abort" class="fnname">unwrap_or_abort</a>(self) -> Self::<a class="associatedtype" href="trait.ResultExt.html#associatedtype.Ok" title="type proc_macro_error::ResultExt::Ok">Ok</a></h4></div></summary><div class="docblock"><p>Behaves like <code>Result::unwrap</code>: if self is <code>Ok</code> yield the contained value,
|
||
otherwise abort macro execution via <code>abort!</code>.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.expect_or_abort" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/proc_macro_error/lib.rs.html#368" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.expect_or_abort" class="fnname">expect_or_abort</a>(self, msg: &<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.str.html">str</a>) -> Self::<a class="associatedtype" href="trait.ResultExt.html#associatedtype.Ok" title="type proc_macro_error::ResultExt::Ok">Ok</a></h4></div></summary><div class="docblock"><p>Behaves like <code>Result::expect</code>: if self is <code>Ok</code> yield the contained value,
|
||
otherwise abort macro execution via <code>abort!</code>.
|
||
If it aborts then resulting error message will be preceded with <code>message</code>.</p>
|
||
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-ResultExt-for-Result%3CT%2C%20E%3E" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/proc_macro_error/lib.rs.html#390-410" title="goto source code">[src]</a></div><a href="#impl-ResultExt-for-Result%3CT%2C%20E%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, E: <a class="trait" href="https://doc.rust-lang.org/1.59.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="struct.Diagnostic.html" title="struct proc_macro_error::Diagnostic">Diagnostic</a>>> <a class="trait" href="trait.ResultExt.html" title="trait proc_macro_error::ResultExt">ResultExt</a> for <a class="enum" href="https://doc.rust-lang.org/1.59.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, E></h3></div></summary><div class="impl-items"><div id="associatedtype.Ok-1" class="type trait-impl has-srclink"><a href="#associatedtype.Ok-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Ok" class="associatedtype">Ok</a> = T</h4></div><div id="method.unwrap_or_abort" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/proc_macro_error/lib.rs.html#393-398" title="goto source code">[src]</a></div><a href="#method.unwrap_or_abort" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.unwrap_or_abort" class="fnname">unwrap_or_abort</a>(self) -> T</h4></div><div id="method.expect_or_abort" class="method trait-impl has-srclink"><div class="rightside"><a class="srclink" href="../src/proc_macro_error/lib.rs.html#400-409" title="goto source code">[src]</a></div><a href="#method.expect_or_abort" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.expect_or_abort" class="fnname">expect_or_abort</a>(self, message: &<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.str.html">str</a>) -> T</h4></div></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/proc_macro_error/trait.ResultExt.js" async></script></section><section id="search" class="content hidden"></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.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |