Struct spandex_hyphenation::hyphenator::Word

pub struct Word<'t, Break> {
    pub text: &'t str,
    pub breaks: Vec<Break>,
}

A hyphenated word carrying valid breaks.

The Word can be borrowed or moved for iteration with iter() and into_iter() respectively.

Fields

text: &'t str

breaks: Vec<Break>

Trait Implementations

impl<'t> Iter<'t> for Word<'t, usize>

type Iter = Segments<'t, Cloned<Iter<'t, usize>>>

Important traits for Hyphenating<'m, I>

impl<'m, I, S> Iterator for Hyphenating<'m, I> where
    I: Iterator<Item = S> + ExactSizeIterator,
    S: AsRef<str>,  type Item = String;

fn iter(&'t self) -> Hyphenating<'t, Self::Iter>

impl<'t> IntoIterator for Word<'t, usize>

type Item = String

The type of the elements being iterated over.

type IntoIter = Hyphenating<'t, Segments<'t, IntoIter<usize>>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'t> IntoIterator for Word<'t, (usize, Option<&'t Subregion>)>

type Item = String

The type of the elements being iterated over.

type IntoIter = Hyphenating<'t, SegmentsExt<'t, IntoIter<(usize, Option<&'t Subregion>)>>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'t, Break: Clone> Clone for Word<'t, Break>

fn clone(&self) -> Word<'t, Break>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'t, Break: Eq> Eq for Word<'t, Break>

impl<'t, Break: PartialEq> PartialEq<Word<'t, Break>> for Word<'t, Break>

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

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

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

This method tests for !=.

impl<'t, Break: Debug> Debug for Word<'t, Break>

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

Formats the value using the given formatter.

impl<'t, Break: Hash> Hash for Word<'t, Break>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'t, Break> StructuralPartialEq for Word<'t, Break>

impl<'t, Break> StructuralEq for Word<'t, Break>