mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 00:18:24 +00:00
20 lines
7.8 KiB
HTML
20 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="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.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-e935ef01ae1c1829.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.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-4c98445ec4002617.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><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 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.11.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><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../either/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">either</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/either/lib.rs.html#1-1519">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></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>"use_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="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.for_both.html" title="macro either::for_both">for_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.try_left.html" title="macro either::try_left">try_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_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">IterEither</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">IntoEither</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></section></div></main></body></html> |