Struct StructuredOutputContext 

pub struct StructuredOutputContext {
    pub forced_mode: bool,
    pub force_attempted: bool,
    pub stop_loop: bool,
    /* private fields */
}

Per-invocation context for structured output execution.

Fields

forced_mode: bool

Whether forced mode is active.

force_attempted: bool

Whether force was attempted.

stop_loop: bool

Whether to stop the event loop.

Implementations

impl StructuredOutputContext

pub fn new() -> Self

Creates a new structured output context.

pub fn with_type<T: JsonSchema + DeserializeOwned>() -> Self

Creates a new structured output context with a specific output type.

pub fn with_tool_name(name: impl Into<String>, spec: Option<ToolSpec>) -> Self

Creates a new structured output context with a specific tool name and spec.

pub fn get_tool_spec(&self) -> Option<&ToolSpec>

Returns the tool specification if available.

pub fn register_tool(&self, registry: &mut ToolRegistry) -> bool

Registers the structured output tool with the given registry.

Returns true if a tool was registered, false otherwise.

pub fn cleanup(&self, registry: &mut ToolRegistry)

Removes the structured output tool from the given registry.

pub fn is_enabled(&self) -> bool

Check if structured output is enabled for this context.

pub fn expected_tool_name(&self) -> Option<&str>

Get the expected tool name.

pub fn store_result(&mut self, tool_use_id: &str, result: Value)

Store a validated structured output result.

pub fn get_result(&self, tool_use_id: &str) -> Option<&Value>

Retrieve a stored structured output result.

pub fn set_forced_mode(&mut self)

Mark this context as being in forced structured output mode.

pub fn has_structured_output_tool(&self, tool_names: &[String]) -> bool

Check if any tool uses are for the structured output tool.

pub fn extract_result(&mut self, tool_use_ids: &[String]) -> Option<Value>

Extract and remove structured output result from stored results.

Trait Implementations

impl Clone for StructuredOutputContext

fn clone(&self) -> StructuredOutputContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructuredOutputContext

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

Formats the value using the given formatter.

impl Default for StructuredOutputContext

fn default() -> StructuredOutputContext

Returns the “default value” for a type.