Struct hayagriva::lang::TitleCase

#[non_exhaustive]
pub struct TitleCase {
    pub always_capitalize_after_punctuation: bool,
    pub always_capitalize_last_word: bool,
    pub always_capitalize_min_len: Option<usize>,
    pub hyphen_word_separator: bool,
    pub keep_all_uppercase_words: bool,
    pub use_exception_dictionary: bool,
    pub trim_start: bool,
    pub trim_end: bool,
}

Rules for the title case transformation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

always_capitalize_after_punctuation: bool

Always capitalize after a full stop, question or exclamation mark, and colon even if the punctuation is followed by a word on the capitalization blacklist.

always_capitalize_last_word: bool

Always capitalize the last word of the title, even if it is on the capitalization blacklist.

always_capitalize_min_len: Option<usize>

Always capitalize a word matching or exceeding a certain length, even if it is on the capitalization blacklist.

hyphen_word_separator: bool

Treat the hyphen as a word separator, i. e. capitalize in hyphenated expressions.

keep_all_uppercase_words: bool

Do not touch all-uppercase words like “USA” if the title contains lower-case characters at all.

use_exception_dictionary: bool

Enable usage of the capitalization blacklist.

trim_start: bool

Discard whitespace at the start of the title.

trim_end: bool

Discard whitespace at the end of the title.

Implementations

impl TitleCase

pub fn new() -> Self

Construct TitleCaseProperties with the default values.

Trait Implementations

impl Clone for TitleCase

fn clone(&self) -> TitleCase

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TitleCase

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TitleCase

fn default() -> Self

Returns the “default value” for a type.

impl From<TitleCase> for Case

fn from(props: TitleCase) -> Self

Converts to this type from the input type.

impl PartialEq for TitleCase

fn eq(&self, other: &TitleCase) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for TitleCase

impl Eq for TitleCase

impl StructuralPartialEq for TitleCase