Struct tokenizers::processors::template::SpecialToken

pub struct SpecialToken { /* private fields */ }

Represents a bunch of tokens to be used in a template. Usually, special tokens have only one associated id/token but in some cases, it might be interesting to have multiple ids/tokens.

Examples

// Simple cases, where a single id/token is necessary:
let cls = SpecialToken::from(("[CLS]", 1));
let sep = SpecialToken::from((0, "[SEP]")); // The order in the tuple is not important

// More complex case with multiple values:
let complex = SpecialToken::new(
    "A complex special token:".into(),
    vec![0, 1, 2, 3, 4],
    vec!["A".into(), "complex".into(), "special".into(), "token".into(), ":".into()]
).unwrap();

Implementations

impl SpecialToken

pub fn new(id: String, ids: Vec<u32>, tokens: Vec<String>) -> Result<Self>

Trait Implementations

impl Clone for SpecialToken

fn clone(&self) -> SpecialToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpecialToken

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpecialToken

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<(&str, u32)> for SpecialToken

fn from(v: (&str, u32)) -> Self

Converts to this type from the input type.

impl From<(String, u32)> for SpecialToken

fn from(v: (String, u32)) -> Self

Converts to this type from the input type.

impl From<(u32, &str)> for SpecialToken

fn from(v: (u32, &str)) -> Self

Converts to this type from the input type.

impl From<(u32, String)> for SpecialToken

fn from(v: (u32, String)) -> Self

Converts to this type from the input type.

impl PartialEq for SpecialToken

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

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

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

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

impl Serialize for SpecialToken

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SpecialToken

impl StructuralPartialEq for SpecialToken