Skip to main content

TextStats

Struct TextStats 

Source
pub struct TextStats {
    pub words: u64,
    pub sentences: u64,
    pub characters: u64,
    pub characters_no_spaces: u64,
    pub avg_word_length: f64,
    pub avg_sentence_length: f64,
    pub estimated_reading_seconds: f64,
    pub estimated_reading_minutes: u64,
    pub difficulty_score: f64,
}
Expand description

The full bundle of computed statistics for a piece of text.

All fields are computed from a single pass over the input. Counts are u64 so they compose cleanly with very large documents; averages and durations are f64.

Fields§

§words: u64

Number of whitespace-or-punctuation-delimited word tokens.

§sentences: u64

Number of sentence-ending units (. ! ?), with a trailing sentence counted even if the final terminator is omitted.

§characters: u64

Total number of Unicode scalar values (Rust chars), including whitespace and punctuation.

§characters_no_spaces: u64

Characters excluding ASCII whitespace.

§avg_word_length: f64

Average number of characters per word (letters only, per word).

§avg_sentence_length: f64

Average number of words per sentence.

§estimated_reading_seconds: f64

Estimated reading time in seconds (at WORDS_PER_MINUTE).

§estimated_reading_minutes: u64

Estimated reading time in whole minutes (rounded up, minimum 1 if the text is non-empty).

§difficulty_score: f64

A 0–100 lexile-like difficulty estimate; higher means harder.

Implementations§

Source§

impl TextStats

Source

pub fn difficulty_band(&self) -> Difficulty

Map the continuous difficulty_score to a coarse band.

Trait Implementations§

Source§

impl Clone for TextStats

Source§

fn clone(&self) -> TextStats

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextStats

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for TextStats

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for TextStats

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.