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

macro io-enum

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

19 releases (8 stable)

new 1.2.0 Jan 16, 2025
1.1.3 Jan 27, 2024
1.1.1 Jun 29, 2023
1.1.0 Mar 26, 2023
0.1.3 Mar 4, 2019

#549 in Rust patterns

Download history 10327/week @ 2024-09-27 10966/week @ 2024-10-04 14722/week @ 2024-10-11 14666/week @ 2024-10-18 15394/week @ 2024-10-25 13869/week @ 2024-11-01 15145/week @ 2024-11-08 13082/week @ 2024-11-15 13885/week @ 2024-11-22 15470/week @ 2024-11-29 19987/week @ 2024-12-06 16836/week @ 2024-12-13 13399/week @ 2024-12-20 9641/week @ 2024-12-27 15954/week @ 2025-01-03 18661/week @ 2025-01-10

60,044 downloads per month
Used in 132 crates (3 directly)

Apache-2.0 OR MIT

16KB
86 lines

io-enum

crates.io docs.rs license msrv github actions

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

Usage

Add this to your Cargo.toml:

[dependencies]
io-enum = "1"

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

~255–700KB
~16K SLoC