Google Git
Sign in
android / platform / external / rust / crates / heck / b8de81efe9fe60e41c794af1fefc3fe29a601e8c
commitb8de81efe9fe60e41c794af1fefc3fe29a601e8c[log] [tgz]
authorJoel Galenson <jgalenson@google.com>Tue Aug 24 18:23:50 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Tue Aug 24 18:23:50 2021 +0000
treed0ee06504f67c40a7c5a06e2c036f8a3a8f4ee2f
parent644cdc0d2d68bb96aec4c17ce693b5e4e5ac04a5 [diff]
parentdf3d36afcfefcbce120086811f69779784f09625 [diff]
Update TEST_MAPPING am: df3d36afcf

Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/heck/+/1806083

Change-Id: I0351013b0bd3bcb2527818558734e1c3000c6544
tree: d0ee06504f67c40a7c5a06e2c036f8a3a8f4ee2f
  1. src/
  2. LICENSE ⇨ LICENSE-APACHE
  3. NOTICE ⇨ LICENSE
  4. .cargo_vcs_info.json
  5. .gitignore
  6. Android.bp
  7. Cargo.toml
  8. Cargo.toml.orig
  9. LICENSE-APACHE
  10. LICENSE-MIT
  11. METADATA
  12. MODULE_LICENSE_APACHE2
  13. OWNERS
  14. README.md
  15. TEST_MAPPING
README.md

heck is a case conversion library

I specifically requested the opposite of this.

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.

Definition of a word boundary

Word boundaries are defined as the “unicode words” defined in the unicode_segmentation library, as well as within those words in this manner:

  1. All underscore characters are considered word boundaries.
  2. If an uppercase character is followed by lowercase letters, a word boundary is considered to be just prior to that uppercase character.
  3. If multiple uppercase characters are consecutive, they are considered to be within a single word, except that the last will be part of the next word if it is followed by lowercase characters (see rule 2).

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.

Cases contained in this library:

  1. CamelCase
  2. snake_case
  3. kebab-case
  4. SHOUTY_SNAKE_CASE
  5. mixedCase
  6. Title Case
  7. SHOUTY-KEBAB-CASE

Contributing

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. :-)

MSRV

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.

License

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.