Expand description
heck is a case conversion library.
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:
- All underscore characters are considered word boundaries.
- If an uppercase character is followed by lowercase letters, a word boundary is considered to be just prior to that uppercase character.
- 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:
- UpperCamelCase
- lowerCamelCase
- snake_case
- kebab-case
- SHOUTY_SNAKE_CASE
- Title Case
- SHOUTY-KEBAB-CASE
- Train-Case
Structs§
- This wrapper performs a kebab case conversion in
fmt::Display
. - This wrapper performs a lower camel case conversion in
fmt::Display
. - This wrapper performs a upper camel case conversion in
fmt::Display
. - This wrapper performs a kebab case conversion in
fmt::Display
. - This wrapper performs a shouty snake case conversion in
fmt::Display
. - This wrapper performs a shouty snake case conversion in
fmt::Display
. - This wrapper performs a snake case conversion in
fmt::Display
. - This wrapper performs a snake case conversion in
fmt::Display
. - This wrapper performs a title case conversion in
fmt::Display
. - This wrapper performs a train case conversion in
fmt::Display
. - This wrapper performs a upper camel case conversion in
fmt::Display
.
Traits§
- This trait defines a kebab case conversion.
- This trait defines a lower camel case conversion.
- ToPascalCase is an alias for ToUpperCamelCase. See ToUpperCamelCase for more documentation.
- This trait defines a shouty kebab case conversion.
- This trait defines a shouty snake case conversion.
- Oh heck, ToShoutySnekCase is an alias for ToShoutySnakeCase. See ToShoutySnakeCase for more documentation.
- This trait defines a snake case conversion.
- Oh heck, SnekCase is an alias for ToSnakeCase. See ToSnakeCase for more documentation.
- This trait defines a title case conversion.
- This trait defines a train case conversion.
- This trait defines an upper camel case conversion.