arti/crates/caret
Nick Mathewson 7a5373c110 Run fixup-features --no-annotate for initial Cargo.toml fixes.
This does the following:
  - Gives every crate a `full`.
  - Cause every `full` to depend on `full` from the lower-level
    crates.
  - Makes every feature listed _directly_ in `experimental` depend
    on `__is_experimental`.
2023-05-15 09:07:21 -04:00
..
src caret: work correctly when there are no defined variants. 2023-02-28 11:08:34 -05:00
tests Disable clippy::unlinlined-format-args 2023-01-27 08:27:47 -05:00
Cargo.toml Run fixup-features --no-annotate for initial Cargo.toml fixes. 2023-05-15 09:07:21 -04:00
README.md doc: consistent summary line for the READMEs 2022-12-20 14:31:47 +01:00

README.md

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