Struct Words

pub struct Words<'a> { /* private fields */ }

Sequence of words of some original string.

Divides the case style “enforcement” into two steps:

1. Split the original string into words.
2. Capitalise and concatenate the words into a new string.

Implementations

impl<'a> Words<'a>

pub fn with_separator(s: &'a str, sep: &Regex) -> Words<'a>

Creates a new Words of the string slice using the separator regex to split it.

pub fn camel(&self) -> String

Returns the words capitalised and concatenated like camelCase as a new String.

pub fn pascal(&self) -> String

Returns the words capitalised and concatenated like PascalCase as a new String.

pub fn kebab(&self) -> String

Returns the words capitalised and concatenated like kebab-case as a new String.

pub fn screaming_kebab(&self) -> String

Returns the words capitalised and concatenated like SCREAMING-KEBAB-CASE as a new String.

pub fn lower(&self) -> String

Returns the words capitalised and concatenated like lower case as a new String.

pub fn upper(&self) -> String

Returns the words capitalised and concatenated like UPPER CASE as a new String.

pub fn snake(&self) -> String

Returns the words capitalised and concatenated like snake_case as a new String.

pub fn screaming_snake(&self) -> String

Returns the words capitalised and concatenated like SCREAMING_SNAKE_CASE as a new String.

pub fn title(&self) -> String

Returns the words capitalised and concatenated like Title Case as a new String.

pub fn toggle(&self) -> String

Returns the words capitalised and concatenated like tOGGLE cASE as a new String.

pub fn random(&self) -> String

Returns the words case-randomised and concatenated with a space as a new String.

Trait Implementations

impl<'a> From<&'a str> for Words<'a>

fn from(s: &'a str) -> Self

Creates a new Words for the string slice.

The string is split into words by the following algorithm:

1. Trim the string.
2. If the string contains whitespace, then split it by whitespace.
3. If the string contains hyphens ‘-’ or underscores ‘_’, then split it by whichever of them is more frequent.
4. Split the string by case changes: ‘*|Az’ and ‘z|A*’.