#io #derive #enum

macro io-enum

#[derive(Read, Write, Seek, BufRead)] for enums

16 releases (5 stable)

1.1.1 Jun 29, 2023
1.1.0 Mar 26, 2023
1.0.2 Dec 10, 2022
1.0.1 Apr 6, 2021
0.1.3 Mar 4, 2019

#1211 in Rust patterns

Download history 6051/week @ 2023-07-29 6812/week @ 2023-08-05 7203/week @ 2023-08-12 8884/week @ 2023-08-19 7382/week @ 2023-08-26 7185/week @ 2023-09-02 7068/week @ 2023-09-09 7398/week @ 2023-09-16 6031/week @ 2023-09-23 5492/week @ 2023-09-30 6851/week @ 2023-10-07 6748/week @ 2023-10-14 6596/week @ 2023-10-21 6944/week @ 2023-10-28 6836/week @ 2023-11-04 5597/week @ 2023-11-11

27,041 downloads per month
Used in 104 crates (3 directly)

Apache-2.0 OR MIT

11KB
89 lines

io-enum

crates.io docs.rs license rustc build status

#[derive(Read, Write, Seek, BufRead)] for enums.

Usage

Add this to your Cargo.toml:

[dependencies]
io-enum = "1"

Compiler support: requires rustc 1.56+

Examples

use std::{
    fs::File,
    io::{self, Write},
    path::Path,
};

use io_enum::*;

#[derive(Read, Write, Seek, BufRead)]
enum Either<A, B> {
    A(A),
    B(B),
}

fn func(path: Option<&Path>) -> impl Write {
    if let Some(path) = path {
        Either::A(File::open(path).unwrap())
    } else {
        Either::B(io::stdout())
    }
}

See auto_enums crate for how to automate patterns like this.

Supported traits

  • auto_enums: A library for to allow multiple return types by automatically generated enum.
  • derive_utils: A procedural macro helper for easily writing derives macros for enums.
  • iter-enum: #[derive(Iterator, DoubleEndedIterator, ExactSizeIterator, FusedIterator, Extend)] for enums.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~370–800KB
~19K SLoC