#read-write #enums #io #file-io #derive #file-path #proc-macro

macro io-enum

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

18 releases (7 stable)

1.1.3 Jan 27, 2024
1.1.1 Jun 29, 2023
1.1.0 Mar 26, 2023
1.0.2 Dec 10, 2022
0.1.3 Mar 4, 2019

#561 in Rust patterns

Download history 8173/week @ 2024-08-14 8664/week @ 2024-08-21 9637/week @ 2024-08-28 10419/week @ 2024-09-04 9171/week @ 2024-09-11 9764/week @ 2024-09-18 9430/week @ 2024-09-25 10937/week @ 2024-10-02 13188/week @ 2024-10-09 16017/week @ 2024-10-16 14640/week @ 2024-10-23 14651/week @ 2024-10-30 13520/week @ 2024-11-06 14217/week @ 2024-11-13 14044/week @ 2024-11-20 11470/week @ 2024-11-27

55,179 downloads per month
Used in 129 crates (3 directly)

Apache-2.0 OR MIT

14KB
86 lines

io-enum

crates.io docs.rs license rust version github actions

#[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

~245–680KB
~16K SLoC