pub struct GrammarCompiler { /* private fields */ }Expand description
Compiler that turns grammars / schemas / structural tags into a
CompiledGrammar, bound to a single tokenizer.
Port of the vendored xgrammar::GrammarCompiler.
Implementations§
Source§impl GrammarCompiler
impl GrammarCompiler
Sourcepub fn new(
tokenizer_info: &TokenizerInfo,
max_threads: i32,
cache_enabled: bool,
cache_limit_bytes: isize,
) -> Result<Self, String>
pub fn new( tokenizer_info: &TokenizerInfo, max_threads: i32, cache_enabled: bool, cache_limit_bytes: isize, ) -> Result<Self, String>
Construct the compiler.
max_threads and cache_limit_bytes keep the vendored integer
types (i32 / isize); they are range-checked and forwarded to
the pure-Rust core. Port of the vendored GrammarCompiler::new.
Sourcepub fn compile_json_schema(
&mut self,
schema: &str,
any_whitespace: bool,
indent: Option<i32>,
separators: Option<(impl AsRef<str>, impl AsRef<str>)>,
strict_mode: bool,
max_whitespace_cnt: Option<i32>,
) -> Result<CompiledGrammar, String>
pub fn compile_json_schema( &mut self, schema: &str, any_whitespace: bool, indent: Option<i32>, separators: Option<(impl AsRef<str>, impl AsRef<str>)>, strict_mode: bool, max_whitespace_cnt: Option<i32>, ) -> Result<CompiledGrammar, String>
Compile a JSON schema. Port of the vendored
GrammarCompiler::compile_json_schema.
Sourcepub fn compile_builtin_json_grammar(
&mut self,
) -> Result<CompiledGrammar, String>
pub fn compile_builtin_json_grammar( &mut self, ) -> Result<CompiledGrammar, String>
Compile the built-in standard-JSON grammar. Port of the vendored
GrammarCompiler::compile_builtin_json_grammar.
Sourcepub fn compile_grammar_from_ebnf(
&mut self,
ebnf_string: &str,
root_rule_name: &str,
) -> Result<CompiledGrammar, String>
pub fn compile_grammar_from_ebnf( &mut self, ebnf_string: &str, root_rule_name: &str, ) -> Result<CompiledGrammar, String>
Compile a grammar from an EBNF string. Port of the vendored
GrammarCompiler::compile_grammar_from_ebnf.
Sourcepub fn compile_grammar(
&mut self,
grammar: &Grammar,
) -> Result<CompiledGrammar, String>
pub fn compile_grammar( &mut self, grammar: &Grammar, ) -> Result<CompiledGrammar, String>
Compile a Grammar handle. Port of the vendored
GrammarCompiler::compile_grammar.
The pure-Rust core consumes a GrammarData by value; the handle
is cloned so the caller keeps ownership (vendored took &Grammar).
Sourcepub fn compile_structural_tag_json(
&mut self,
structural_tag_json: &str,
) -> Result<CompiledGrammar, String>
pub fn compile_structural_tag_json( &mut self, structural_tag_json: &str, ) -> Result<CompiledGrammar, String>
Compile a grammar from a structural-tag JSON document. Port of
the vendored GrammarCompiler::compile_structural_tag (raw-JSON
form).
Sourcepub fn clear_cache(&mut self)
pub fn clear_cache(&mut self)
Clear the compiled-grammar cache. Port of the vendored
GrammarCompiler::clear_cache.
Sourcepub fn get_cache_size_bytes(&self) -> i64
pub fn get_cache_size_bytes(&self) -> i64
Approximate cache size in bytes. Port of the vendored
GrammarCompiler::get_cache_size_bytes.
Sourcepub fn load_mask_snapshot(&self, path: &Path) -> Result<usize, String>
pub fn load_mask_snapshot(&self, path: &Path) -> Result<usize, String>
Seed the cross-grammar rule-level mask cache from a snapshot a
previous process wrote (#918). Returns masks imported; 0 is a
miss (absent / stale / corrupt file), never an error.
Sourcepub fn save_mask_snapshot(
&self,
path: &Path,
max_entries: usize,
) -> Result<usize, String>
pub fn save_mask_snapshot( &self, path: &Path, max_entries: usize, ) -> Result<usize, String>
Persist the cross-grammar rule-level mask cache so the next process starts warm (#918). Returns masks written.
Sourcepub fn rule_cache_handle(&self) -> Option<RuleLevelCache>
pub fn rule_cache_handle(&self) -> Option<RuleLevelCache>
A CLONE of the cross-grammar rule-level cache handle (Arc
inside — this shares the cache, it does not copy it).
#918: lets a caller hand the cache to a background thread that
persists it, without holding the compiler (which is !Sync).
Sourcepub fn snapshot_identity(&self) -> SnapshotIdentity
pub fn snapshot_identity(&self) -> SnapshotIdentity
The identity an on-disk mask snapshot must match to be usable with this compiler’s tokenizer (#918).
Sourcepub fn rule_cache_len(&self) -> usize
pub fn rule_cache_len(&self) -> usize
Number of masks held by the cross-grammar rule-level cache.
Sourcepub fn cache_limit_bytes(&self) -> i64
pub fn cache_limit_bytes(&self) -> i64
The configured cache memory limit (-1 = unlimited). Port of
the vendored GrammarCompiler::cache_limit_bytes.
Auto Trait Implementations§
impl Freeze for GrammarCompiler
impl RefUnwindSafe for GrammarCompiler
impl Send for GrammarCompiler
impl Sync for GrammarCompiler
impl Unpin for GrammarCompiler
impl UnwindSafe for GrammarCompiler
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.