mistralrs::llguidance::api

Struct GrammarWithLexer

pub struct GrammarWithLexer {
    pub name: Option<String>,
    pub nodes: Vec<Node>,
    pub json_schema: Option<Value>,
    pub lark_grammar: Option<String>,
    pub greedy_lexer: bool,
    pub greedy_skip_rx: Option<RegexSpec>,
    pub contextual: Option<bool>,
    pub rx_nodes: Vec<RegexNode>,
    pub allow_initial_skip: bool,
    pub no_forcing: bool,
    pub allow_invalid_utf8: bool,
}

Fields§

§name: Option<String>

The name of this grammar, can be used in GenGrammar nodes.

§nodes: Vec<Node>

The start symbol is at nodes[0] When nodes is empty, then one of json_schema or lark_grammar must be set.

§json_schema: Option<Value>

The JSON schema that the grammar should generate. When this is set, nodes and rx_nodes must be empty.

§lark_grammar: Option<String>

The Lark grammar that the grammar should generate. When this is set, nodes and rx_nodes must be empty.

§greedy_lexer: bool

This is no longer used. When enabled, the grammar can use Lexeme but not Gen. When disabled, the grammar can use Gen but not Lexeme. String is allowed in either case as a shorthand for either Lexeme or Gen.

§greedy_skip_rx: Option<RegexSpec>

Only applies to greedy_lexer grammars. This adds a new lexeme that will be ignored when parsing.

§contextual: Option<bool>

The default value for ‘contextual’ in Lexeme nodes.

§rx_nodes: Vec<RegexNode>

When set, the regexps can be referenced by their id (position in this list).

§allow_initial_skip: bool

If set, the grammar will allow skip_rx as the first lexeme.

§no_forcing: bool

Normally, when a sequence of bytes is forced by grammar, it is tokenized canonically and forced as tokens. With no_forcing, we let the model decide on tokenization. This generally reduces both quality and speed, so should not be used outside of testing.

§allow_invalid_utf8: bool

If set, the grammar will allow invalid utf8 byte sequences. Any Unicode regex will cause an error.

Implementations§

impl GrammarWithLexer

pub fn from_lark(lark_grammar: String) -> GrammarWithLexer

pub fn from_regex(rx: RegexNode) -> GrammarWithLexer

Trait Implementations§

impl Clone for GrammarWithLexer

fn clone(&self) -> GrammarWithLexer

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for GrammarWithLexer

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

Formats the value using the given formatter. Read more

impl Default for GrammarWithLexer

fn default() -> GrammarWithLexer

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for GrammarWithLexer

fn deserialize<D>( deserializer: D, ) -> Result<GrammarWithLexer, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for GrammarWithLexer

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for GrammarWithLexer

impl RefUnwindSafe for GrammarWithLexer

impl Send for GrammarWithLexer

impl Sync for GrammarWithLexer

impl Unpin for GrammarWithLexer

impl UnwindSafe for GrammarWithLexer

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsAny for T
where T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

fn type_name(&self) -> &'static str

Gets the type name of self

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> Downcast for T
where T: AsAny + ?Sized,

fn is<T>(&self) -> bool
where T: AsAny,

Returns true if the boxed type is the same as T. Read more

fn downcast_ref<T>(&self) -> Option<&T>
where T: AsAny,

Forward to the method defined on the type Any.

fn downcast_mut<T>(&mut self) -> Option<&mut T>
where T: AsAny,

Forward to the method defined on the type Any.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeSendSync for T

impl<T> Ungil for T
where T: Send,