commit | 53b364a4323b42475bf7eff68dff09bf4c9a6a3d | [log] [tgz] |
---|---|---|
author | Matthew Maurer <mmaurer@google.com> | Tue Mar 07 17:24:02 2023 -0800 |
committer | Matthew Maurer <mmaurer@google.com> | Tue Mar 07 17:24:02 2023 -0800 |
tree | 23a6f8a5c260b8f34c2d84dd0e11a8cf08682f92 | |
parent | 3e60f5b81b948c51007fac11c410de092cae9ca4 [diff] |
Make heck available to product and vendor Bug: 270690570 Test: mma in external/rust/crates Change-Id: Iae52d6a1be24f2cb143a03b784c138185f6c3859
This library exists to provide case conversion between common cases like CamelCase and snake_case. It is intended to be unicode aware, internally consistent, and reasonably well performing.
Word boundaries are defined as the “unicode words” defined in the unicode_segmentation
library, as well as within those words in this manner:
That is, “HelloWorld” is segmented Hello|World
whereas “XMLHttpRequest” is segmented XML|Http|Request
.
Characters not within words (such as spaces, punctuations, and underscores) are not included in the output string except as they are a part of the case being converted to. Multiple adjacent word boundaries (such as a series of underscores) are folded into one. (“hello__world” in snake case is therefore “hello_world”, not the exact same string). Leading or trailing word boundary indicators are dropped, except insofar as CamelCase capitalizes the first word.
PRs of additional well-established cases welcome.
This library is a little bit opinionated (dropping punctuation, for example). If that doesn't fit your use case, I hope there is another crate that does. I would prefer not to receive PRs to make this behavior more configurable.
Bug reports & fixes always welcome. :-)
The minimum supported Rust version for this crate is 1.32.0. This may change in minor or patch releases, but we probably won't ever require a very recent version. If you would like to have a stronger guarantee than that, please open an issue.
heck is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See LICENSE-APACHE and LICENSE-MIT for details.