Skip to main content

Sentiment

Struct Sentiment 

Source
pub struct Sentiment {
    pub positive_hits: u32,
    pub negative_hits: u32,
    pub tokens: u32,
}
Expand description

The polarity result of scoring a piece of text.

All fields are derived from simple case-insensitive whole-word matching against POSITIVE_WORDS and NEGATIVE_WORDS.

Fields§

§positive_hits: u32

Number of positive lexicon words matched.

§negative_hits: u32

Number of negative lexicon words matched.

§tokens: u32

Total tokens the lexicons were matched against (word count).

Implementations§

Source§

impl Sentiment

Source

pub fn net(&self) -> i64

Net polarity: positive_hits - negative_hits.

Positive when the text leans positive, negative when it leans negative, zero when balanced (or empty).

Source

pub fn comparison(&self) -> f64

Comparison score in -1.0..=1.0: (positive - negative) / (positive + negative).

Returns 0.0 when no polarity words were found.

Source

pub fn positive_share(&self) -> f64

Proportion of polarity-bearing tokens that are positive, in 0.0..=1.0.

Returns 0.0 when no polarity words were found.

Source

pub fn label(&self) -> &'static str

Coarse label for the overall polarity.

Trait Implementations§

Source§

impl Clone for Sentiment

Source§

fn clone(&self) -> Sentiment

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 Sentiment

Source§

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

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

impl Eq for Sentiment

Source§

impl PartialEq for Sentiment

Source§

fn eq(&self, other: &Sentiment) -> 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 Sentiment

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.