Struct textwrap::core::Word

pub struct Word<'a> {
    pub word: &'a str,
    pub whitespace: &'a str,
    pub penalty: &'a str,
    // some fields omitted
}

A piece of wrappable text, including any trailing whitespace.

A Word is an example of a Fragment, so it has a width, trailing whitespace, and potentially a penalty item.

Fields

word: &'a str

Word content.

whitespace: &'a str

Whitespace to insert if the word does not fall at the end of a line.

penalty: &'a str

Penalty string to insert if the word falls at the end of a line.

Implementations

impl<'a> Word<'a>

pub fn from(word: &str) -> Word<'_>

Construct a Word from a string.

A trailing stretch of ' ' is automatically taken to be the whitespace part of the word.

pub fn break_apart<'b>(
    &'b self,
    line_width: usize
) -> impl Iterator<Item = Word<'a>> + 'b

Break this word into smaller words with a width of at most line_width. The whitespace and penalty from this Word is added to the last piece.

Examples

use textwrap::core::Word;
assert_eq!(
    Word::from("Hello!  ").break_apart(3).collect::<Vec<_>>(),
    vec![Word::from("Hel"), Word::from("lo!  ")]
);

Trait Implementations

impl<'a> Clone for Word<'a>

fn clone(&self) -> Word<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Word<'a>

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

Formats the value using the given formatter.

impl Deref for Word<'_>

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Fragment for Word<'_>

fn width(&self) -> usize

Displayed width of word represented by this fragment.

fn whitespace_width(&self) -> usize

Displayed width of the whitespace that must follow the word when the word is not at the end of a line.

fn penalty_width(&self) -> usize

Displayed width of the penalty that must be inserted if the word falls at the end of a line.

impl<'a> PartialEq<Word<'a>> for Word<'a>

fn eq(&self, other: &Word<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Word<'a>) -> bool

This method tests for !=.

impl<'a> Copy for Word<'a>

impl<'a> Eq for Word<'a>

impl<'a> StructuralEq for Word<'a>

impl<'a> StructuralPartialEq for Word<'a>