Struct twitter_text::TwitterTextParseResults

pub struct TwitterTextParseResults {
    pub weighted_length: i32,
    pub permillage: i32,
    pub is_valid: bool,
    pub display_text_range: Range,
    pub valid_text_range: Range,
}

A struct that represents a parsed tweet containing the length of the tweet, its validity, display ranges etc. The name mirrors Twitter's Java implementation.

Fields

weighted_length: i32

The weighted length is the number used to determine the tweet's length for the purposes of Twitter's limit of 280. Most characters count for 2 units, while a few ranges (like ASCII and Latin-1) count for 1. See Twitter's blog post.

permillage: i32

The weighted length expressed as a number relative to a limit of 1000. This value makes it easier to implement UI like Twitter's tweet-length meter.

is_valid: bool

Whether the tweet is valid: its weighted length must be under the configured limit, it must not be empty, and it must not contain invalid characters.

display_text_range: Range

The display range expressed in UTF-16.

valid_text_range: Range

The valid display range expressed in UTF-16. After the end of the valid range, clients typically stop highlighting entities, etc.

Implementations

impl TwitterTextParseResults

pub fn new(
    weighted_length: i32,
    permillage: i32,
    is_valid: bool,
    display_text_range: Range,
    valid_text_range: Range
) -> TwitterTextParseResults

A new TwitterTextParseResults struct with all fields supplied as arguments.

pub fn empty() -> TwitterTextParseResults

An invalid TwitterTextParseResults struct. This function produces the return value when empty text or invalid UTF-8 is supplied to parse().

Trait Implementations

impl Clone for TwitterTextParseResults

fn clone(&self) -> TwitterTextParseResults

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TwitterTextParseResults

impl Debug for TwitterTextParseResults

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

Formats the value using the given formatter.

impl Eq for TwitterTextParseResults

impl Hash for TwitterTextParseResults

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<TwitterTextParseResults> for TwitterTextParseResults

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for TwitterTextParseResults

impl StructuralPartialEq for TwitterTextParseResults