18 lines
7.0 KiB
HTML
18 lines
7.0 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="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-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.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]--><rustdoc-topbar><h2><a href="#">Crate either</a></h2></rustdoc-topbar><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></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><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><dl class="item-table reexports"><dt id="reexport.Left"><code>pub use crate::Either::<a class="enum" href="enum.Either.html#variant.Left" title="enum either::Either">Left</a>;</code></dt><dt id="reexport.Right"><code>pub use crate::Either::<a class="enum" href="enum.Either.html#variant.Right" title="enum either::Either">Right</a>;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="serde_untagged/index.html" title="mod either::serde_untagged">serde_<wbr>untagged</a></dt><dd>Untagged serialization/deserialization support for Either<L, R>.</dd><dt><a class="mod" href="serde_untagged_optional/index.html" title="mod either::serde_untagged_optional">serde_<wbr>untagged_<wbr>optional</a></dt><dd>Untagged serialization/deserialization support for Option<Either<L, R>>.</dd></dl><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.for_both.html" title="macro either::for_both">for_<wbr>both</a></dt><dd>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>.</dd><dt><a class="macro" href="macro.try_left.html" title="macro either::try_left">try_<wbr>left</a></dt><dd>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.</dd><dt><a class="macro" href="macro.try_right.html" title="macro either::try_right">try_<wbr>right</a></dt><dd>Dual to <a href="macro.try_left.html" title="macro either::try_left"><code>try_left!</code></a>, see its documentation for more information.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.IterEither.html" title="struct either::IterEither">Iter<wbr>Either</a></dt><dd>Iterator that maps left or right iterators to corresponding <code>Either</code>-wrapped items.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Either.html" title="enum either::Either">Either</a></dt><dd>The enum <code>Either</code> with variants <code>Left</code> and <code>Right</code> is a general purpose
|
|
sum type with two cases.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.IntoEither.html" title="trait either::IntoEither">Into<wbr>Either</a></dt><dd>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>.</dd></dl></section></div></main></body></html> |