mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 11:59:33 +01:00
13 lines
8.8 KiB
HTML
13 lines
8.8 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."><title>ResultExt in proc_macro_error - 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_error" 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_error/index.html">proc_<wbr>macro_<wbr>error</a><span class="version">1.0.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Result<wbr>Ext</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Ok" title="Ok">Ok</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.expect_or_abort" title="expect_or_abort">expect_or_abort</a></li><li><a href="#tymethod.unwrap_or_abort" title="unwrap_or_abort">unwrap_or_abort</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ResultExt-for-Result%3CT,+E%3E" title="Result<T, E>">Result<T, E></a></li></ul><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>error</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_error</a></span><h1>Trait <span class="trait">ResultExt</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_error/lib.rs.html#358-369">source</a> </span></div><pre class="rust item-decl"><code>pub trait ResultExt {
|
||
|
|
type <a href="#associatedtype.Ok" class="associatedtype">Ok</a>;
|
||
|
|
|
||
|
|
// Required methods
|
||
|
|
fn <a href="#tymethod.unwrap_or_abort" class="fn">unwrap_or_abort</a>(self) -> Self::<a class="associatedtype" href="trait.ResultExt.html#associatedtype.Ok" title="type proc_macro_error::ResultExt::Ok">Ok</a>;
|
||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.expect_or_abort" class="fn">expect_or_abort</a>(self, msg: &<a class="primitive" href="https://doc.rust-lang.org/1.83.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><details class="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="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Ok" class="method"><a class="src rightside" href="../src/proc_macro_error/lib.rs.html#359">source</a><h4 class="code-header">type <a href="#associatedtype.Ok" class="associatedtype">Ok</a></h4></section></div><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.unwrap_or_abort" class="method"><a class="src rightside" href="../src/proc_macro_error/lib.rs.html#363">source</a><h4 class="code-header">fn <a href="#tymethod.unwrap_or_abort" class="fn">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></section></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="toggle method-toggle" open><summary><section id="tymethod.expect_or_abort" class="method"><a class="src rightside" href="../src/proc_macro_error/lib.rs.html#368">source</a><h4 class="code-header">fn <a href="#tymethod.expect_or_abort" class="fn">expect_or_abort</a>(self, msg: &<a class="primitive" href="https://doc.rust-lang.org/1.83.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></section></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="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-ResultExt-for-Result%3CT,+E%3E" class="impl"><a class="src rightside" href="../src/proc_macro_error/lib.rs.html#390-410">source</a><a href="#impl-ResultExt-for-Result%3CT,+E%3E" class="anchor">§</a><h3 class="code-header">impl<T, E: <a class="trait" href="https://doc.rust-lang.org/1.83.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.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, E></h3></section></summary><div class="impl-items"><section id="associatedtype.Ok-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/proc_macro_error/lib.rs.html#391">source</a><a href="#associatedtype.Ok-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Ok" class="associatedtype">Ok</a> = T</h4></section><section id="method.unwrap_or_abort" class="method trait-impl"><a class="src rightside" href="../src/proc_macro_error/lib.rs.html#393-398">source</a><a href="#method.unwrap_or_abort" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.unwrap_or_abort" class="fn">unwrap_or_abort</a>(self) -> T</h4></section><section id="method.expect_or_abort" class="method trait-impl"><a class="src rightside" href="../src/proc_macro_error/lib.rs.html#400-409">source</a><a href="#method.expect_or_abort" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.expect_or_abort" class="fn">expect_or_abort</a>(self, message: &<a class="primitive" href="https://doc.rust-lang.org/1.83.0/std/primitive.str.html">str</a>) -> T</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/proc_macro_error/trait.ResultExt.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html>
|