-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathindex.html
19 lines (19 loc) · 8.91 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<!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="The enum `Either` with variants `Left` and `Right` is a general purpose sum type with two cases."><title>either - 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-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="either" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0 (4d91de4e4 2025-02-17)" data-channel="1.85.0" data-search-js="search-75f5ac3e.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="../either/index.html">either</a><span class="version">1.15.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="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><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>either</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/either/lib.rs.html#1-1561">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The enum <a href="enum.Either.html"><code>Either</code></a> with variants <code>Left</code> and <code>Right</code> is a general purpose
sum type with two cases.</p>
<p><strong>Crate features:</strong></p>
<ul>
<li>
<p><code>"std"</code>
Enabled by default. Disable to make the library <code>#![no_std]</code>.</p>
</li>
<li>
<p><code>"serde"</code>
Disabled by default. Enable to <code>#[derive(Serialize, Deserialize)]</code> for <code>Either</code></p>
</li>
</ul>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Left"><code>pub use crate::Either::<a class="enum" href="enum.Either.html" title="enum either::Either">Left</a>;</code></div></li><li><div class="item-name" id="reexport.Right"><code>pub use crate::Either::<a class="enum" href="enum.Either.html" title="enum either::Either">Right</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="into_either/index.html" title="mod either::into_either">into_<wbr>either</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">The trait <a href="trait.IntoEither.html" title="trait either::IntoEither"><code>IntoEither</code></a> provides methods for converting a type <code>Self</code>, whose
size is constant and known at compile-time, into an <a href="enum.Either.html" title="enum either::Either"><code>Either</code></a> variant.</div></li><li><div class="item-name"><a class="mod" href="iterator/index.html" title="mod either::iterator">iterator</a><span title="Restricted Visibility"> 🔒</span> </div></li></ul><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.check_t.html" title="macro either::check_t">check_t</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">A helper macro to check if AsRef and AsMut are implemented for a given type.</div></li><li><div class="item-name"><a class="macro" href="macro.for_both.html" title="macro either::for_both">for_<wbr>both</a></div><div class="desc docblock-short">Evaluate the provided expression for both <a href="enum.Either.html#variant.Left" title="variant either::Either::Left"><code>Either::Left</code></a> and <a href="enum.Either.html#variant.Right" title="variant either::Either::Right"><code>Either::Right</code></a>.</div></li><li><div class="item-name"><a class="macro" href="macro.impl_specific_ref_and_mut.html" title="macro either::impl_specific_ref_and_mut">impl_<wbr>specific_<wbr>ref_<wbr>and_<wbr>mut</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="macro" href="macro.map_either.html" title="macro either::map_either">map_<wbr>either</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="macro" href="macro.try_left.html" title="macro either::try_left">try_<wbr>left</a></div><div class="desc docblock-short">Macro for unwrapping the left side of an <a href="enum.Either.html" title="enum either::Either"><code>Either</code></a>, which fails early
with the opposite side. Can only be used in functions that return
<code>Either</code> because of the early return of <code>Right</code> that it provides.</div></li><li><div class="item-name"><a class="macro" href="macro.try_right.html" title="macro either::try_right">try_<wbr>right</a></div><div class="desc docblock-short">Dual to <a href="macro.try_left.html" title="macro either::try_left"><code>try_left!</code></a>, see its documentation for more information.</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.IterEither.html" title="struct either::IterEither">Iter<wbr>Either</a></div><div class="desc docblock-short">Iterator that maps left or right iterators to corresponding <code>Either</code>-wrapped items.</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.Either.html" title="enum either::Either">Either</a></div><div class="desc docblock-short">The enum <code>Either</code> with variants <code>Left</code> and <code>Right</code> is a general purpose
sum type with two cases.</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.IntoEither.html" title="trait either::IntoEither">Into<wbr>Either</a></div><div class="desc docblock-short">Provides methods for converting a type <code>Self</code> into either a <a href="enum.Either.html#variant.Left" title="variant either::Either::Left"><code>Left</code></a> or <a href="enum.Either.html#variant.Right" title="variant either::Either::Right"><code>Right</code></a>
variant of <a href="enum.Either.html" title="enum either::Either"><code>Either<Self, Self></code></a>.</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._unsized_ref_propagation.html" title="fn either::_unsized_ref_propagation">_unsized_<wbr>ref_<wbr>propagation</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn._unsized_std_propagation.html" title="fn either::_unsized_std_propagation">_unsized_<wbr>std_<wbr>propagation</a><span title="Restricted Visibility"> 🔒</span> </div></li></ul></section></div></main></body></html>