#![doc = include_str!("../README.md")]
pub mod analysis;
pub mod config;
pub mod error;
pub mod fst_store;
pub mod json_store;
pub mod lexicon;
pub mod plugin;
#[doc(hidden)]
pub mod util;
mod casing;
mod classify;
mod context;
mod locale;
mod rules;
mod titlecase;
mod token;
mod tokenizer;
pub use analysis::{CasingRule, CasingSpan, Confidence, TitleCaseAnalysis};
pub use config::{
AllCapsPolicy, HyphenStyle, LocaleProfile, NameParticlePolicy, SmallWordPolicy,
TitleCaseOptions, UnknownWordCasing,
};
pub use error::{Error, Result};
pub use lexicon::ExternalLexicons;
pub use plugin::{
LexiconPlugin, MapEntry, PluginMetadata, PluginPayload, PluginPayloadKind, RankedEntry,
PLUGIN_SCHEMA_VERSION,
};
#[must_use]
pub fn titlecase_mla(input: &str) -> String {
titlecase::titlecase_mla(input)
}
#[must_use]
pub fn titlecase_with_options(input: &str, options: &TitleCaseOptions<'_>) -> String {
titlecase::titlecase_with_options(input, options)
}
pub fn titlecase_into(out: &mut String, input: &str, options: &TitleCaseOptions<'_>) {
titlecase::titlecase_into(out, input, options);
}
#[must_use]
pub fn titlecase_analyze(input: &str) -> TitleCaseAnalysis {
titlecase::titlecase_analyze(input, &TitleCaseOptions::default())
}
#[must_use]
pub fn titlecase_analyze_with_options(
input: &str,
options: &TitleCaseOptions<'_>,
) -> TitleCaseAnalysis {
titlecase::titlecase_analyze(input, options)
}