Crate among

source
Expand description

Among

The enum Among with variants Left, Middle and Right is a general purpose sum type with three cases.

github LoC Build

docs.rs crates.io crates.io license

English | 简体中文

§Introduction

The enum Among with variants Left, Middle and Right and trait implementations.

§Installation

  • Use with default feature

    [dependencies]
    among = "0.1"
  • Use without std and alloc

    [dependencies]
    among = { version = "0.1", default-features = false }
  • Enable futures feature to enable trait implementation including futures::io::AsyncRead, futures::io::AsyncBufRead, futures::io::AsyncWrite, and futures::io::AsyncSeek.

    [dependencies]
    among = { version = "0.1", features = ["futures", "std"] }
  • Enable tokio feature to enable trait implementation including tokio::io::AsyncRead, tokio::io::AsyncBufRead, tokio::io::AsyncWrite and tokio::io::AsyncSeek.

    [dependencies]
    among = { version = "0.1", features = ["tokio", "std"] }

§Pedigree

This code is inspired and modified based on rayon-rs/either.

§License

among is under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE, LICENSE-MIT for details.

Copyright (c) 2024 Al Liu.

Re-exports§

  • pub use crate::Among::Left;
  • pub use crate::Among::Middle;
  • pub use crate::Among::Right;

Modules§

Macros§

Structs§

  • Iterator that maps left or right iterators to corresponding Among-wrapped items.

Enums§

  • The enum Among with variants Left, Middle and Right is a general purpose sum type with three cases.

Traits§