diff options
Diffstat (limited to 'README-crates.io.md')
| -rw-r--r-- | README-crates.io.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/README-crates.io.md b/README-crates.io.md new file mode 100644 index 0000000..d368902 --- /dev/null +++ b/README-crates.io.md @@ -0,0 +1,10 @@ +The enum `Either` with variants `Left` and `Right` is a general purpose +sum type with two cases. + +Either has methods that are similar to Option and Result, and it also implements +traits like `Iterator`. + +Includes macros `try_left!()` and `try_right!()` to use for +short-circuiting logic, similar to how the `?` operator is used with `Result`. +Note that `Either` is general purpose. For describing success or error, use the +regular `Result`. |