Skip to main content

TextStatistics

Struct TextStatistics 

Source
pub struct TextStatistics { /* private fields */ }
Expand description

Text statistics calculator for readability metrics and text complexity analysis.

Implementations§

Source§

impl TextStatistics

Source

pub fn new() -> Self

Create a new TextStatistics analyzer with default tokenizers

Source

pub fn with_tokenizers( wordtokenizer: WordTokenizer, sentencetokenizer: SentenceTokenizer, ) -> Self

Create a TextStatistics analyzer with custom tokenizers

Source

pub fn word_count(&self, text: &str) -> Result<usize>

Count the number of words in text

Source

pub fn sentence_count(&self, text: &str) -> Result<usize>

Count the number of sentences in text

Source

pub fn syllable_count(&self, text: &str) -> Result<usize>

Count total syllables in text

Source

pub fn complex_word_count(&self, text: &str) -> Result<usize>

Count the number of complex words (words with 3+ syllables)

Source

pub fn avg_sentence_length(&self, text: &str) -> Result<f64>

Calculate average sentence length in words

Source

pub fn avg_word_length(&self, text: &str) -> Result<f64>

Calculate average word length in characters

Source

pub fn avg_syllables_per_word(&self, text: &str) -> Result<f64>

Calculate average syllables per word

Source

pub fn flesch_reading_ease(&self, text: &str) -> Result<f64>

Calculate Flesch Reading Ease score

Score interpretation:

  • 90-100: Very easy to read. 5th grade level.
  • 80-89: Easy to read. 6th grade level.
  • 70-79: Fairly easy to read. 7th grade level.
  • 60-69: Standard. 8th-9th grade level.
  • 50-59: Fairly difficult. 10th-12th grade level.
  • 30-49: Difficult. College level.
  • 0-29: Very difficult. College graduate level.
Source

pub fn flesch_kincaid_grade_level(&self, text: &str) -> Result<f64>

Calculate Flesch-Kincaid Grade Level

Returns the U.S. school grade level needed to understand the text

Source

pub fn gunning_fog(&self, text: &str) -> Result<f64>

Calculate Gunning Fog Index

The Gunning Fog Index estimates the years of formal education a person needs to understand the text on first reading

Source

pub fn smog_index(&self, text: &str) -> Result<f64>

Calculate SMOG Index (Simple Measure of Gobbledygook)

SMOG estimates the years of education needed to understand a piece of writing. Typically used for health messages.

Source

pub fn automated_readability_index(&self, text: &str) -> Result<f64>

Calculate Automated Readability Index (ARI)

Returns the U.S. grade level needed to comprehend the text

Source

pub fn coleman_liau_index(&self, text: &str) -> Result<f64>

Calculate Coleman-Liau Index

Returns the U.S. grade level needed to comprehend the text

Source

pub fn dale_chall_readability(&self, text: &str) -> Result<f64>

Calculate Dale-Chall Readability Score

This is a more accurate readability formula, but requires a list of common words, which we approximate here

Source

pub fn lexical_diversity(&self, text: &str) -> Result<f64>

Calculate lexical diversity (unique words / total words)

Source

pub fn type_token_ratio(&self, text: &str) -> Result<f64>

Calculate type-token ratio (synonym for lexical diversity)

Source

pub fn get_all_metrics(&self, text: &str) -> Result<ReadabilityMetrics>

Get all readability metrics in a single call

Trait Implementations§

Source§

impl Clone for TextStatistics

Source§

fn clone(&self) -> TextStatistics

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextStatistics

Source§

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

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

impl Default for TextStatistics

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V