Enum EncodingType

#[repr(i32)]
pub enum EncodingType {
    None = 0,
    Utf8 = 1,
    Utf16 = 2,
    Utf32 = 3,
}

Represents the text encoding that the caller uses to process the output. Providing an EncodingType is recommended because the API provides the beginning offsets for various outputs, such as tokens and mentions, and languages that natively use different text encodings may access offsets differently.

Variants

None = 0

If EncodingType is not specified, encoding-dependent information (such as begin_offset) will be set at -1.

Utf8 = 1

Encoding-dependent information (such as begin_offset) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.

Utf16 = 2

Encoding-dependent information (such as begin_offset) is calculated based on the UTF-16 encoding of the input. Java and Javascript are examples of languages that use this encoding natively.

Utf32 = 3

Encoding-dependent information (such as begin_offset) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively.

Implementations

impl EncodingType

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of EncodingType.

pub fn from_i32(value: i32) -> Option<EncodingType>

Converts an i32 to a EncodingType, or None if value is not a valid variant.

Trait Implementations

impl Clone for EncodingType

fn clone(&self) -> EncodingType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncodingType

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

Formats the value using the given formatter.

impl Default for EncodingType

fn default() -> EncodingType

Returns the “default value” for a type.

impl From<EncodingType> for i32

fn from(value: EncodingType) -> i32

Converts to this type from the input type.

impl Hash for EncodingType

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EncodingType

fn cmp(&self, other: &EncodingType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for EncodingType

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for EncodingType

fn partial_cmp(&self, other: &EncodingType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for EncodingType

impl Eq for EncodingType

impl StructuralPartialEq for EncodingType