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 new( description: Option<String>, properties: impl IntoIterator<Item = (impl Into<String>, DynamicGenerationProperty)>, ) -> Result<Self, FMError>

Build an object schema with FoundationModels’ typed GenerationSchema initializer.

This Rust wrapper uses GeneratedContent as the root Swift type and mirrors the SDK’s property-based schema builder.

Errors

Returns an FMError if the typed schema is invalid.

pub fn new_with_nil_repr( description: Option<String>, represent_nil_explicitly_in_generated_content: bool, properties: impl IntoIterator<Item = (impl Into<String>, DynamicGenerationProperty)>, ) -> Result<Self, FMError>

Build an object schema with FoundationModels’ typed GenerationSchema initializer, optionally requiring explicit null values for optional properties.

Errors

Returns an FMError if the typed schema is invalid or the current runtime does not support explicit null representation.

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 Eq for GenerationSchema

impl PartialEq for GenerationSchema

fn eq(&self, other: &Self) -> 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.