1 unstable release

0.1.0 Feb 12, 2021

#10 in #c-style

Download history 29/week @ 2023-12-11 49/week @ 2023-12-18 7/week @ 2024-01-08 13/week @ 2024-01-22 9/week @ 2024-02-12 25/week @ 2024-02-19 27/week @ 2024-02-26 17/week @ 2024-03-04 23/week @ 2024-03-11 23/week @ 2024-03-18

91 downloads per month
Used in 4 crates (via cstr-enum)

MIT license

8KB
142 lines

cstr-enum GitHub tag (latest SemVer)

A crate for defining C-style string enums.

C APIs sometimes require string constants. One could define a bunch of &CStr constants using the constr_cstr crate, but this becomes unergonomic with a large number of constants. It also does not allow the type checking Rust's enums provide.

This crate provides two traits for converting between to and from &CStr: AsCStr and FromCStr. It also provides derive macros for implementing these traits on enums. The implementations provided by the derive macros perform no allocations, using only static [u8] buffers.

Example usage

use cstr_enum::*;
use std::ffi::CStr;
use std::os::raw::c_char;

#[derive(Debug, Eq, PartialEq, FromCStr, AsCStr)]
enum Constants {
  Apple,
  Bacon,
  Cat = 1337, // user discriminants supported
}

assert_eq!(Constants::Apple.as_cstr().to_bytes_with_nul(), b"Apple\0");

let returned_from_c_api = CStr::from_bytes_with_nul(b"Cat\0").unwrap();
assert_eq!(Constants::from_cstr(returned_from_c_api), Ok(Constants::Cat));

let returned_from_c_api = CStr::from_bytes_with_nul(b"unknown\0").unwrap();
assert_eq!(
  Constants::from_cstr(returned_from_c_api),
  Err("unexpected string while parsing for Constants variant")
);

License

Licensed under MIT.

Dependencies

~1.5MB
~33K SLoC