cenum-utils

Crates.iocenum-utils
lib.rscenum-utils
version0.2.1
created_at2025-05-24 22:48:27.721278+00
updated_at2025-05-28 16:00:38.494344+00
descriptionA minimal library for querying enum properties in const contexts
homepage
repositoryhttps://github.com/Josh194/ConstEnumUtils
max_upload_size
id1687839
size18,614
Josh Nave (Josh194)

documentation

https://docs.rs/cenum-utils

README

cenum_utils provides a minimal set of utilities for querying certain properties of enums in const contexts.


Currently, available features include:

  • Accessing the number of variants in an enum.
  • Accessing the discriminants for all of an enum's variants.
  • Accessing the names for all of an enum's variants.

Example

use cenum_utils::*;

#[derive(ConstEnum)]
#[repr(u8)]
enum Enum {
	X,
	Y,
	Z
}

fn test() {
	assert_eq!(Enum::COUNT, 3);
	assert_eq!(Enum::DISCRIMINANTS, &[0, 1, 2]);
	assert_eq!(Enum::NAMES, &["X", "Y", "Z"])
}

const fn const_test() {
	assert!(Enum::COUNT == 3);

	static NAMES: &[u8] = &[b'X', b'Y', b'Z'];

	let mut i = 0;

	while i < Enum::COUNT {
		assert!(Enum::DISCRIMINANTS[i] as usize == i);
		assert!(Enum::NAMES[i].as_bytes()[0] == NAMES[i]);
		i += 1;
	}
}
Commit count: 17

cargo fmt