Crate stringcase 

This library provides some functions that convert string cases between Ada_Case, camelCase, COBOL-CASE, kebab-case, MACRO_CASE, PascalCase, snake_case, Title Case, and Train-Case. In addition, generic functions capitalize, lowerize, and upperize are provided to convert string cases with a custom joiner character. And this library also provides a trait Caser which enables strings to convert themselves to their cases by their own methods.

Basically, these functions only target ASCII uppercase and lowercase letters for capitalization. All characters other than ASCII uppercase and lowercase letters and ASCII numbers are removed as word separators.

If you want to use some symbols as separators, specify those symbols in the separators field of Options struct and use the 〜case_with_options function for the desired case. If you want to retain certain symbols and use everything else as separators, specify those symbols in keep field of Options struct and use the 〜case_with_options function for the desired case.

Additionally, you can specify whether to place word boundaries before and/or after non-alphabetic characters with conversion options. This can be set using the separate_before_non_alphabets and separate_after_non_alphabets fields in the Options struct.

The 〜_case functions that do not take Options as an argument only place word boundaries after non-alphabetic characters. In other words, they behave as if separate_before_non_alphabets = false and separate_after_non_alphabets = true.

Install

In Cargo.toml, write this crate as a dependency.

[dependencies]
stringcase = "1.0.0"

Usage

The functions in this crate can be used as follows:

use stringcase::snake_case;

fn main() {
    let input = "fooBar123Baz";
    let snake = snake_case(input);
    assert_eq!(snake, "foo_bar123_baz");
}

If you want the conversion to behave differently, use 〜_case_with_options.

use stringcase::{snake_case_with_options, Options};

fn main() {
    let opts = Options{separate_before_non_alphabets: true, ..Default::default()};
    let input = "fooBar123Baz";
    let snake = snake_case_with_options(input, &opts);
    assert_eq!(snake, "foo_bar_123_baz");
}

You can also use the generic functions capitalize, lowerize, and upperize to convert strings into capitalized, lowercased, or uppercased words joined by a custom joiner character:

use stringcase::{capitalize, lowerize, upperize, Options};

fn main() {
    let opts = Options {
        separate_before_non_alphabets: true,
        separate_after_non_alphabets: true,
        ..Default::default()
    };
    let input = "fooBar123Baz";
    assert_eq!(capitalize::<'.'>(input, &opts), "Foo.Bar.123.Baz");
    assert_eq!(lowerize::<'.'>(input, &opts), "foo.bar.123.baz");
    assert_eq!(upperize::<'.'>(input, &opts), "FOO.BAR.123.BAZ");
}

And by bringing Caser with use declaration, it will be able to execute methods of strings, String or &str, to convert to their cases.

use stringcase::{Caser, Options};

fn main() {
    let input = "fooBar123Baz";
    let snake = input.to_snake_case();
    assert_eq!(snake, "foo_bar123_baz");

    let opts = Options{separate_before_non_alphabets: true, ..Default::default()};
    let snake = input.to_snake_case_with_options(&opts);
    assert_eq!(snake, "foo_bar_123_baz");
}

Structs

Options

A struct that represents options for case conversion of strings.

Traits

Caser

Caser is the trait to attach methods for converting strings &str and String to various cases.

Functions

ada_case

Converts the input string to Ada case.

ada_case_with_options

Converts the input string to Ada case with the specified options.

camel_case

Converts the input string to camel case.

camel_case_with_options

Converts the input string to camel case with the specified options.

capitalize

A generic function that converts string cases into a capitalized format joined by a specified joiner character.

cobol_case

Converts the input string to cobol case.

cobol_case_with_options

Converts the input string to cobol case with the specified options.

kebab_case

Converts the input string to kebab case.

kebab_case_with_options

Converts the input string to kebab case with the specified options.

lowerize

A generic function that converts string cases into a lowercased format joined by a specified joiner character.

macro_case

Converts the input string to macro case.

macro_case_with_options

Converts the input string to macro case with the specified options.

pascal_case

Converts the input string to pascal case.

pascal_case_with_options

Converts the input string to pascal case with the specified options.

snake_case

Converts the input string to snake case.

snake_case_with_options

Converts the input string to snake case with the specified options.

title_case

Converts the input string to title case.

title_case_with_options

Converts the input string to title case with the specified options.

train_case

Converts the input string to train case.

train_case_with_options

Converts the input string to train case with the specified options.

upperize

A generic function that converts string cases into an uppercased format joined by a specified joiner character.