snake_case

Crates.iosnake_case
lib.rssnake_case
version0.3.1
sourcesrc
created_at2019-09-24 14:01:20.835533
updated_at2021-03-13 09:08:03.486503
descriptionSnakeCase is a String-like type that can only contain valid non-empty snake_case
homepagehttps://github.com/emilk/snake_case
repositoryhttps://github.com/emilk/snake_case
max_upload_size
id167289
size10,871
Emil Ernerfeldt (emilk)

documentation

README

snake_case

Latest version Documentation Build Status MIT

A Rust crate for working with snake_case identifiers

The purpose of this crate is to expose the type SnakeCase, a wrapper around a String that can only contain valid, non-empty snake_case without leading digits. In other words, it always matches ^[_a-z][_a-z0-9]*$

  • Non-empty
  • Starts with a lower case ASCII letter or underscore
  • Contains only lower case ASCII letters, underscores and digits

NOTE: ___foo__bar_ is considered valid snake case by this crate.

TL;DR: SnakeCase can hold any string that is also a valid lower case identifier in Rust.

Why?

The common case for this is unique identifiers, for which snake case is perfectly suited. SnakeCase will always be valid, meaning you will never have the problem of trailing spaces or empty strings.

Basic usage

let id = SnakeCase::try_from_str("hello_world").unwrap();
assert_eq!(id, "hello_world");

There is also SnakeCaseRef which is a non-owning reference to a snake_case string.

Serde

If you enable the "serde" feature then SnakeCase will implement Serialize and Deserialize.

Deserialize will fail if a string is not valid snake case.

Commit count: 22

cargo fmt