Struct GenerationSchema 

pub struct GenerationSchema { /* private fields */ }

A validated FoundationModels generation schema encoded as JSON Schema.

Implementations

impl GenerationSchema

pub fn from_json_schema(json_schema: impl Into<String>) -> Result<Self, FMError>

Validate and store a JSON schema definition.

Errors

Returns an FMError if Apple’s GenerationSchema rejects the schema.

pub fn from_dynamic( root: DynamicGenerationSchema, dependencies: impl IntoIterator<Item = DynamicGenerationSchema>, ) -> Result<Self, FMError>

Create a schema from a dynamic root schema plus optional dependencies.

Errors

Returns an FMError if the dynamic schema is invalid.

pub fn json_schema(&self) -> &str

The JSON Schema payload accepted by Apple’s GenerationSchema.

pub fn name(&self) -> Option<String>

Best-effort name (the schema’s title).

pub fn string() -> Self

A JSON string schema.

pub fn integer() -> Self

A JSON integer schema.

pub fn number() -> Self

A JSON number schema.

pub fn boolean() -> Self

A JSON boolean schema.

pub fn generated_content() -> Self

A schema for arbitrary JSON (GeneratedContent).

Trait Implementations

impl Clone for GenerationSchema

fn clone(&self) -> GenerationSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerationSchema

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

Formats the value using the given formatter.

impl PartialEq for GenerationSchema

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for GenerationSchema

impl StructuralPartialEq for GenerationSchema