1 2Either 3====== 4 5The enum ``Either`` with variants ``Left`` and ``Right`` and trait 6implementations including Iterator, Read, Write. 7 8Either has methods that are similar to Option and Result. 9 10Includes convenience macros ``try_left!()`` and ``try_right!()`` to use for 11short-circuiting logic. 12 13Please read the `API documentation here`__ 14 15__ https://docs.rs/either/ 16 17|build_status|_ |crates|_ 18 19.. |build_status| image:: https://travis-ci.org/bluss/either.svg?branch=master 20.. _build_status: https://travis-ci.org/bluss/either 21 22.. |crates| image:: http://meritbadge.herokuapp.com/either 23.. _crates: https://crates.io/crates/either 24 25How to use with cargo:: 26 27 [dependencies] 28 either = "1.0" 29 30 31Recent Changes 32-------------- 33 34- 1.1.0 35 36 - Add methods ``left_and_then``, ``right_and_then`` by @rampantmonkey 37 - Include license files in the repository and released crate 38 39- 1.0.3 40 41 - Add crate categories 42 43- 1.0.2 44 45 - Forward more ``Iterator`` methods 46 - Implement ``Extend`` for ``Either<L, R>`` if ``L, R`` do. 47 48- 1.0.1 49 50 - Fix ``Iterator`` impl for ``Either`` to forward ``.fold()``. 51 52- 1.0.0 53 54 - Add default crate feature ``use_std`` so that you can opt out of linking to 55 std. 56 57- 0.1.7 58 59 - Add methods ``.map_left()``, ``.map_right()`` and ``.either()``. 60 - Add more documentation 61 62- 0.1.3 63 64 - Implement Display, Error 65 66- 0.1.2 67 68 - Add macros ``try_left!`` and ``try_right!``. 69 70- 0.1.1 71 72 - Implement Deref, DerefMut 73 74- 0.1.0 75 76 - Initial release 77 - Support Iterator, Read, Write 78 79License 80------- 81 82Dual-licensed to be compatible with the Rust project. 83 84Licensed under the Apache License, Version 2.0 85http://www.apache.org/licenses/LICENSE-2.0 or the MIT license 86http://opensource.org/licenses/MIT, at your 87option. This file may not be copied, modified, or distributed 88except according to those terms. 89