Skip to main content

clean

Function clean 

Source
pub fn clean(text: &str) -> CleaningResult<'_>
Expand description

Convenience: clean with default options.

§Arguments

  • text: Input text to clean.

§Returns

Cleaned output and statistics.

The default preset emits keyboard-safe output. Non-ASCII text is normalized/folded and transliterated when possible (for example "Café" -> "Cafe", "Straße" -> "Strasse"), while characters with no feasible ASCII mapping are removed.

§Errors

This infallible wrapper does not return errors; construct a TextCleaner and call TextCleaner::try_clean for fallible behavior.

§Panics

Panics when normalization is requested but the unorm feature is disabled.