19 lines
7.8 KiB
HTML
19 lines
7.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="rancor"><title>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="../crates.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 mod crate"><!--[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"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#rancor" title="rancor">rancor</a><ul><li><a href="#features" title="Features">Features</a></li></ul></li></ul><h3><a href="#macros">Crate Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>rancor</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#1-759">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="rancor"><a class="doc-anchor" href="#rancor">§</a>rancor</h2>
|
|
<p>rancor provides scalable and efficient error handling without using type
|
|
composition. This makes it best-suited for situations where:</p>
|
|
<ul>
|
|
<li>Programmatic error introspection is not useful</li>
|
|
<li>Functions may error, but succeed most of the time</li>
|
|
<li>Errors should provide as much useful detail as possible when emitted</li>
|
|
<li>Use cases include both <code>no_std</code> and targets with support for <code>std</code></li>
|
|
</ul>
|
|
<h3 id="features"><a class="doc-anchor" href="#features">§</a>Features</h3>
|
|
<ul>
|
|
<li><code>alloc</code>: Provides the <a href="struct.BoxedError.html" title="struct rancor::BoxedError"><code>BoxedError</code></a> type. Enabled by default.</li>
|
|
</ul>
|
|
</div></details><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.fail.html" title="macro rancor::fail">fail</a></div><div class="desc docblock-short">Returns the given error from this function.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.BoxedError.html" title="struct rancor::BoxedError">Boxed<wbr>Error</a></div><div class="desc docblock-short">An error type that preserves all detailed error messages. It is optimized
|
|
to fit in a single pointer.</div></li><li><div class="item-name"><a class="struct" href="struct.Error.html" title="struct rancor::Error">Error</a></div><div class="desc docblock-short">A good general-purpose error type.</div></li><li><div class="item-name"><a class="struct" href="struct.Failure.html" title="struct rancor::Failure">Failure</a></div><div class="desc docblock-short">An error type that only preserves success or failure, throwing away any more
|
|
detailed error messages.</div></li><li><div class="item-name"><a class="struct" href="struct.Strategy.html" title="struct rancor::Strategy">Strategy</a></div><div class="desc docblock-short">Equips a type with a <code>Fallible</code> implementation that chooses <code>E</code> as its error
|
|
type.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Infallible.html" title="enum rancor::Infallible">Infallible</a></div><div class="desc docblock-short">A re-export of <code>core::convert::Infallible</code>.
|
|
The error type for errors that can never happen.</div></li><li><div class="item-name"><a class="enum" href="enum.Panic.html" title="enum rancor::Panic">Panic</a></div><div class="desc docblock-short">An error type that does not occupy any space, panicking on creation instead.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Fallible.html" title="trait rancor::Fallible">Fallible</a></div><div class="desc docblock-short">A type with fallible operations that return its associated error type.</div></li><li><div class="item-name"><a class="trait" href="trait.Never.html" title="trait rancor::Never">Never</a></div><div class="desc docblock-short">A type that can never be produced.</div></li><li><div class="item-name"><a class="trait" href="trait.OptionExt.html" title="trait rancor::OptionExt">Option<wbr>Ext</a></div><div class="desc docblock-short">Helper methods for <code>Option</code>s.</div></li><li><div class="item-name"><a class="trait" href="trait.ResultExt.html" title="trait rancor::ResultExt">Result<wbr>Ext</a></div><div class="desc docblock-short">Helper methods for <code>Result</code>s.</div></li><li><div class="item-name"><a class="trait" href="trait.Source.html" title="trait rancor::Source">Source</a></div><div class="desc docblock-short">An error type which can be uniformly constructed from an <a href="struct.Error.html" title="struct rancor::Error"><code>Error</code></a> and
|
|
additional trace information.</div></li><li><div class="item-name"><a class="trait" href="trait.Trace.html" title="trait rancor::Trace">Trace</a></div><div class="desc docblock-short">An error type which can add additional “trace” information to itself.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.unreachable_checked.html" title="fn rancor::unreachable_checked">unreachable_<wbr>checked</a></div><div class="desc docblock-short">Consumes a <code>Never</code> type, returning a primitive <code>!</code>.</div></li></ul></section></div></main></body></html> |