CompiledGrammar

Struct CompiledGrammar 

Source
pub struct CompiledGrammar { /* private fields */ }
Expand description

This is the primary object to store compiled grammar.

A CompiledGrammar can be used to construct GrammarMatcher to generate token masks efficiently.

§Notes

Do not construct this class directly, instead use GrammarCompiler to construct the object.

Implementations§

Source§

impl CompiledGrammar

Source

pub fn grammar(&self) -> Grammar

The original grammar.

Source

pub fn tokenizer_info(&self) -> TokenizerInfo

The tokenizer info associated with the compiled grammar.

Source

pub fn memory_size_bytes(&self) -> usize

The approximate memory usage of the compiled grammar in bytes.

Source

pub fn serialize_json(&self) -> String

Serialize the compiled grammar to a JSON string. It will serialize the compiled grammar without the tokenizer info, since the tokenizer info is shared by multiple compiled grammars.

§Notes

The metadata of the tokenizer info is serialized and will be checked when deserializing.

Source

pub fn deserialize_json( json: &str, tokenizer_info: &TokenizerInfo, ) -> Result<Self, String>

Deserialize the compiled grammar from a JSON string and associate it with the specified tokenizer info.

Returns

  • Ok(CompiledGrammar) on success
  • Err(String) if the JSON is invalid, format mismatch, version mismatch, or tokenizer metadata does not match. The error string mirrors the C++ exception message.

Trait Implementations§

Source§

impl Drop for CompiledGrammar

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

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> 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, 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.