Struct Truncate

pub struct Truncate;

Available on crate feature stdlib only.

truncate shortens a string down to the number of characters passed as a parameter.

Note that this function operates on grapheme clusters (or user-perceived character), rather than Unicode code points. Each grapheme cluster may be composed of more than one Unicode code point, and does not necessarily correspond to rust’s conception of a character.

If the number of characters specified is less than the length of the string, an ellipsis (...) is appended to the string and is included in the character count.

Custom ellipsis

truncate takes an optional second parameter that specifies the sequence of characters to be appended to the truncated string. By default this is an ellipsis (...), but you can specify a different sequence.

The length of the second parameter counts against the number of characters specified by the first parameter. For example, if you want to truncate a string to exactly 10 characters, and use a 3-character ellipsis, use 13 for the first parameter of truncate, since the ellipsis counts as 3 characters.

No ellipsis

You can truncate to the exact number of characters specified by the first parameter and show no trailing characters by passing a blank string as the second parameter.

Trait Implementations

impl Clone for Truncate

fn clone(&self) -> Truncate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl FilterReflection for Truncate

fn name(&self) -> &'static str

fn description(&self) -> &'static str

fn positional_parameters(&self) -> &'static [ParameterReflection]

fn keyword_parameters(&self) -> &'static [ParameterReflection]

impl ParseFilter for Truncate

fn parse(&self, args: FilterArguments<'_>) -> Result<Box<dyn Filter>>

Filter input based on arguments.

fn reflection(&self) -> &dyn FilterReflection