39 lines
7.2 KiB
HTML
39 lines
7.2 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 type with fallible operations that return its associated error type."><title>Fallible in rancor - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="rancor" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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="../rancor/index.html">rancor</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Fallible</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</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 rancor</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">rancor</a></span><h1>Trait <span class="trait">Fallible</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/rancor/lib.rs.html#154-157">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Fallible {
|
||
type <a href="#associatedtype.Error" class="associatedtype">Error</a>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A type with fallible operations that return its associated error type.</p>
|
||
<p><code>Fallible</code> turns an error type parameter into an associated type of another
|
||
parameter. You can equip an existing type with a <code>Fallible</code> implementation
|
||
by wrapping it in a <a href="struct.Strategy.html" title="struct rancor::Strategy"><code>Strategy</code></a>.</p>
|
||
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rancor::{Failure, Fallible, Strategy};
|
||
|
||
<span class="kw">trait </span>Operator<E = <<span class="self">Self </span><span class="kw">as </span>Fallible>::Error> {
|
||
<span class="kw">fn </span>operate(<span class="kw-2">&</span><span class="self">self</span>, lhs: i32, rhs: i32) -> <span class="prelude-ty">Result</span><i32, E>;
|
||
}
|
||
|
||
<span class="kw">impl</span><T: Operator<E> + <span class="question-mark">?</span>Sized, E> Operator<E> <span class="kw">for </span>Strategy<T, E> {
|
||
<span class="kw">fn </span>operate(<span class="kw-2">&</span><span class="self">self</span>, lhs: i32, rhs: i32) -> <span class="prelude-ty">Result</span><i32, E> {
|
||
T::operate(<span class="self">self</span>, lhs, rhs)
|
||
}
|
||
}
|
||
|
||
<span class="kw">struct </span>Add;
|
||
|
||
<span class="kw">impl</span><E> Operator<E> <span class="kw">for </span>Add {
|
||
<span class="kw">fn </span>operate(<span class="kw-2">&</span><span class="self">self</span>, lhs: i32, rhs: i32) -> <span class="prelude-ty">Result</span><i32, E> {
|
||
<span class="prelude-val">Ok</span>(lhs + rhs)
|
||
}
|
||
}
|
||
|
||
<span class="kw">fn </span>operate_one_one<T: Operator + Fallible>(
|
||
operator: <span class="kw-2">&</span>T,
|
||
) -> <span class="prelude-ty">Result</span><i32, T::Error> {
|
||
operator.operate(<span class="number">1</span>, <span class="number">1</span>)
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
operate_one_one(Strategy::<<span class="kw">_</span>, Failure>::wrap(<span class="kw-2">&mut </span>Add)),
|
||
<span class="prelude-val">Ok</span>(<span class="number">2</span>)
|
||
);</code></pre></div>
|
||
</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"><details class="toggle" open><summary><section id="associatedtype.Error" class="method"><a class="src rightside" href="../src/rancor/lib.rs.html#156">Source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a></h4></section></summary><div class="docblock"><p>The error type associated with this type’s operations.</p>
|
||
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-Fallible-for-Strategy%3CT,+E%3E" class="impl"><a class="src rightside" href="../src/rancor/lib.rs.html#196-198">Source</a><a href="#impl-Fallible-for-Strategy%3CT,+E%3E" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, E> <a class="trait" href="trait.Fallible.html" title="trait rancor::Fallible">Fallible</a> for <a class="struct" href="struct.Strategy.html" title="struct rancor::Strategy">Strategy</a><T, E></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/rancor/lib.rs.html#197">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = E</h4></section></div></details></div><script src="../trait.impl/rancor/trait.Fallible.js" async></script></section></div></main></body></html> |