Struct TextOutputSchema 

pub struct TextOutputSchema { /* private fields */ }

Schema for plain text output.

This schema validates text output with optional constraints:

• Pattern matching via regex
• Minimum/maximum length
• Trim whitespace

Example

use serdes_ai_output::TextOutputSchema;

let schema = TextOutputSchema::new()
    .with_min_length(10)
    .with_max_length(1000)
    .trim();

Implementations

impl TextOutputSchema

pub fn new() -> TextOutputSchema

Create a new text output schema with no constraints.

pub fn with_pattern(self, pattern: &str) -> Result<TextOutputSchema, Error>

Set a regex pattern the output must match.

Errors

Returns an error if the pattern is invalid.

pub fn with_min_length(self, len: usize) -> TextOutputSchema

Set the minimum length constraint.

pub fn with_max_length(self, len: usize) -> TextOutputSchema

Set the maximum length constraint.

pub fn trim(self) -> TextOutputSchema

Enable whitespace trimming.

Trait Implementations

impl Clone for TextOutputSchema

fn clone(&self) -> TextOutputSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextOutputSchema

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

Formats the value using the given formatter.

impl Default for TextOutputSchema

fn default() -> TextOutputSchema

Returns the “default value” for a type.

impl IntoOutputSpec<String> for TextOutputSchema

fn into_output_spec(self) -> OutputSpec<String>

Convert into an output spec.

impl OutputSchema<String> for TextOutputSchema

fn mode(&self) -> OutputMode

The preferred output mode for this schema.

fn parse_text(&self, text: &str) -> Result<String, OutputParseError>

Parse output from text.

fn parse_tool_call( &self, _name: &str, args: &Value, ) -> Result<String, OutputParseError>

Parse output from a tool call.

fn parse_native(&self, value: &Value) -> Result<String, OutputParseError>

Parse output from native structured response.

fn tool_definitions(&self) -> Vec<ToolDefinition>

Get tool definitions if using tool mode.

fn json_schema(&self) -> Option<ObjectJsonSchema>

Get JSON schema for native/prompted mode.

fn supports_mode(&self, mode: OutputMode) -> bool

Whether this schema supports a given output mode.

fn parse( &self, mode: OutputMode, text: Option<&str>, tool_name: Option<&str>, args: Option<&Value>, ) -> Result<T, OutputParseError>

Parse output based on the mode.