Enum textwrap::WordSeparator

pub enum WordSeparator {
    AsciiSpace,
    Custom(fn(line: &str) -> Box<dyn Iterator<Item = Word<'_>> + '_>),
}

Describes where words occur in a line of text.

The simplest approach is say that words are separated by one or more ASCII spaces (' '). This works for Western languages without emojis. A more complex approach is to use the Unicode line breaking algorithm, which finds break points in non-ASCII text.

The line breaks occur between words, please see WordSplitter for options of how to handle hyphenation of individual words.

Examples

use textwrap::core::Word;
use textwrap::WordSeparator::AsciiSpace;

let words = AsciiSpace.find_words("Hello World!").collect::<Vec<_>>();
assert_eq!(words, vec![Word::from("Hello "), Word::from("World!")]);

Variants

AsciiSpace

Find words by splitting on runs of ' ' characters.

Examples

use textwrap::core::Word;
use textwrap::WordSeparator::AsciiSpace;

let words = AsciiSpace.find_words("Hello   World!").collect::<Vec<_>>();
assert_eq!(words, vec![Word::from("Hello   "),
                       Word::from("World!")]);

Custom(fn(line: &str) -> Box<dyn Iterator<Item = Word<'_>> + '_>)

Find words using a custom word separator

Implementations

impl WordSeparator

pub const fn new() -> Self

Create a new word separator.

The best available algorithm is used by default, i.e., [WordSeparator::UnicodeBreakProperties] if available, otherwise WordSeparator::AsciiSpace.

pub fn find_words<'a>(
    &self,
    line: &'a str
) -> Box<dyn Iterator<Item = Word<'a>> + 'a>

Find all words in line.

Trait Implementations

impl Clone for WordSeparator

fn clone(&self) -> WordSeparator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WordSeparator

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

Formats the value using the given formatter.

impl PartialEq<WordSeparator> for WordSeparator

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

Compare two word separators.

use textwrap::WordSeparator;

assert_eq!(WordSeparator::AsciiSpace, WordSeparator::AsciiSpace);
#[cfg(feature = "unicode-linebreak")] {
    assert_eq!(WordSeparator::UnicodeBreakProperties,
               WordSeparator::UnicodeBreakProperties);
}

Note that WordSeparator::Custom values never compare equal:

use textwrap::WordSeparator;
use textwrap::core::Word;
fn word_separator(line: &str) -> Box<dyn Iterator<Item = Word<'_>> + '_> {
    Box::new(line.split_inclusive(' ').map(Word::from))
}
assert_ne!(WordSeparator::Custom(word_separator),
           WordSeparator::Custom(word_separator));

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 WordSeparator