Struct textwrap::HyphenSplitter

pub struct HyphenSplitter;

Simple and default way to split words: splitting on existing hyphens only.

You probably don’t need to use this type since it’s already used by default by Wrapper::new.

Trait Implementations

impl Clone for HyphenSplitter

fn clone(&self) -> HyphenSplitter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HyphenSplitter

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

Formats the value using the given formatter.

impl WordSplitter for HyphenSplitter

HyphenSplitter is the default WordSplitter used by Wrapper::new. It will split words on any existing hyphens in the word.

It will only use hyphens that are surrounded by alphanumeric characters, which prevents a word like “–foo-bar” from being split on the first or second hyphen.

fn split<'w>(&self, word: &'w str) -> Vec<(&'w str, &'w str, &'w str)>

Return all possible splits of word. Each split is a triple with a head, a hyphen, and a tail where head + &hyphen + &tail == word. The hyphen can be empty if there is already a hyphen in the head.