#macro #enum

caret

Macros for declaring non-exhaustive C-style enumerations, with named members

4 releases

0.0.3 Jan 11, 2022
0.0.2 Nov 30, 2021
0.0.1 Oct 29, 2021
0.0.0 Jun 24, 2021

#209 in Rust patterns

Download history 4/week @ 2021-10-02 4/week @ 2021-10-09 5/week @ 2021-10-16 28/week @ 2021-10-23 22/week @ 2021-10-30 11/week @ 2021-11-06 12/week @ 2021-11-13 17/week @ 2021-11-20 41/week @ 2021-11-27 25/week @ 2021-12-04 18/week @ 2021-12-11 23/week @ 2021-12-18 47/week @ 2021-12-25 14/week @ 2022-01-01 43/week @ 2022-01-08 30/week @ 2022-01-15

137 downloads per month
Used in 18 crates (4 directly)

MIT/Apache

8KB
90 lines

caret

caret: Integers with some named values.

Crikey! Another Rust Enum Tool?

Suppose you have an integer type with some named values. For example, you might be implementing a protocol where "command" can be any 8-bit value, but where only a small number of commands are recognized.

In that case, you can use the [caret_int] macro to define a wrapper around u8 so named values are displayed with their preferred format, but you can still represent all the other values of the field:

use caret::caret_int;
caret_int!{
    struct Command(u8) {
       Get = 0,
       Put = 1,
       Swap = 2,
    }
}

let c1: Command = 2.into();
let c2: Command = 100.into();

assert_eq!(c1.to_string().as_str(), "Swap");
assert_eq!(c2.to_string().as_str(), "100");

assert_eq!(c1, Command::Swap);

This crate is developed as part of Arti, a project to implement Tor in Rust. Many other crates in Arti depend on it, but it should be of general use.

License: MIT OR Apache-2.0

No runtime deps

a