Struct Words 

pub struct Words { /* private fields */ }

A message split into numbered words.

Implementations

impl Words

pub fn split(text: &str) -> Self

Splits text.

pub fn text(&self) -> &str

The message as given.

pub fn len(&self) -> usize

How many words it has.

pub fn is_empty(&self) -> bool

Whether it has none.

pub fn words(&self) -> &[Word]

The words.

pub const fn check(&self, span: Span) -> Result<(), SpanError>

Checks that span is inside the message.

Errors

SpanError when it is not.

pub fn slice(&self, span: Span) -> Result<&str, SpanError>

The exact text a span covers, from its first word’s start to its last word’s end.

Errors

SpanError when the span is not inside the message.

pub fn bytes(&self, span: Span) -> Result<(usize, usize), SpanError>

The byte range a span covers.

Errors

SpanError when the span is not inside the message.

pub fn narrow(&self, span: Span, copied: &str) -> Option<Span>

The words inside span that copied repeats, compared without case and without the punctuation at either end of a word; None when they are not there.

pub fn only_place(&self, copied: &str) -> Option<Span>

Where in the whole message copied is repeated, when it is repeated in one place only.

pub fn range(&self, span: Span) -> Result<WordRange, SpanError>

The words a span covers, with their byte range.

Errors

SpanError when the span is not inside the message.

pub fn render(&self) -> String

The message rendered for a model: one line per sentence, each word prefixed with its number counted from 1, S1: [1]I [2]want.

Trait Implementations

impl Clone for Words

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Words

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

Formats the value using the given formatter.

impl Eq for Words

impl PartialEq for Words

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Words