Struct EncodingType

pub struct EncodingType(/* private fields */);

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.

Implementations

impl EncodingType

pub const NONE: EncodingType

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

pub const UTF8: EncodingType

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.

pub const UTF16: EncodingType

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.

pub const UTF32: EncodingType

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.

pub fn value(&self) -> i32

Gets the enum value.

pub fn as_str_name(&self) -> Cow<'static, str>

Gets the enum value as a string.

pub fn from_str_name(name: &str) -> Option<Self>

Creates an enum value from the value name.

Trait Implementations

impl Clone for EncodingType

fn clone(&self) -> EncodingType

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EncodingType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<i32> for EncodingType

fn from(value: i32) -> Self

Converts to this type from the input type.

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 Serialize for EncodingType

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EncodingType