Enum Grammar 

pub enum Grammar {
    JsonSchema {
        json_schema: Value,
        label: Option<String>,
        strict: Option<bool>,
    },
    Regex {
        regex: String,
        label: Option<String>,
        strict: Option<bool>,
    },
    Ebnf {
        ebnf: String,
        label: Option<String>,
        strict: Option<bool>,
    },
}

A constraint on the shape of the generated text.

Exactly one of the three forms applies; the enum makes that structural rather than a runtime check.

Variants

JsonSchema

Output must validate against this JSON schema.

Fields

json_schema: Value

label: Option<String>

strict: Option<bool>

Regex

Output must match this regular expression.

Fields

regex: String

label: Option<String>

strict: Option<bool>

Ebnf

Output must parse under this EBNF grammar.

Fields

ebnf: String

label: Option<String>

strict: Option<bool>

Implementations

impl Grammar

pub fn json_schema(schema: Value) -> Self

Constrain output to a JSON schema.

pub fn regex(pattern: impl Into<String>) -> Self

Constrain output to a regular expression.

pub fn ebnf(grammar: impl Into<String>) -> Self

Constrain output to an EBNF grammar.

Trait Implementations

impl Clone for Grammar

fn clone(&self) -> Grammar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Grammar

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Grammar

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Grammar

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Grammar

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 Grammar