Struct estimated_read_time::Options

pub struct Options { /* fields omitted */ }

Some Options to be set which decides the calculation of avg. time taken to read a text.

Methods

impl Options

pub fn new() -> Options

Creates a new instance of Options with default values set. For Default Values, refer the documentation of each method below.

pub fn word_length(self, word_length: u32) -> Self

Avg. length of one word which will be used to count the total no. of word in the content passed.

Arguments

• word_length - The word length to be considered to count the total no. of words. [Default Value - 4]

pub fn get_word_length(&self) -> u32

Returns the avg. word length used to compute the total no. of words in a text.

pub fn wpm(self, wpm: u32) -> Self

The Avg. WPM (Words per minute) a person can read or taken to read a text

Arguments

• wpm - The Avg. WPM to be considered for the text. [Default Value - 265]

pub fn get_wpm(&self) -> u32

Returns the avg. WPM

pub fn technical_document(self, is_technical_document: bool) -> Self

Sets whether the text is a technical document or not. Setting this to true assumes that reading a technical document takes more time than a simple document.

Arguments

• is_technical_document - true/false. [Default Value - false]

pub fn is_technical_document(&self) -> bool

Returns whether it is technical document.

pub fn technical_difficulty(self, technical_difficulty: u8) -> Self

Sets the technical difficulty of the document. More the difficuly, more time to read.

Arguments

• technical_difficulty - Technical Difficulty value in the range [1, 5]. [Default Value - 3]

pub fn get_technical_difficulty(&self) -> u8

Returns the Technical Difficulty value.

pub fn previous_read_time(self, total_words: u64, total_seconds: u64) -> Self

Total Words read in Total Seconds previously. If this is set, it will be used to calculate WPM. This Calculated WPM takes higher precedence than the default WPM and WPM set using wpm().

This can be useful when maintaining state for individual users.

Arguments

• total_words - Total Words read. [Default Value - 0]
• total_seconds - Total seconds taken to read the total_words. [Default Value - 0]

pub fn build(self) -> Result<Options, String>

Trait Implementations

impl Default for Options

Returns the Options object with the default values set.

fn default() -> Options

Returns the "default value" for a type.