Struct WorkbookToolError 

#[non_exhaustive]
pub struct WorkbookToolError {
    pub code: String,
    pub field: Option<String>,
    pub reason: String,
    pub allowed: Option<Vec<String>>,
    pub range: Option<(Value, Value)>,
    pub required: Option<Vec<String>>,
}

One structured tool-execution error (WBSV-06): a machine-actionable repair payload. The agent reads allowed/range/required to repair the call — “allowed-values live in the error”.

code is one of the four stable machine-readable strings documented in the module-level self-repair table.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: String

The stable error code (one of the four documented codes).

field: Option<String>

The offending input field, when located.

reason: String

A human-readable reason.

allowed: Option<Vec<String>>

The allowed alternatives (e.g. the variable-tier override keys for a strict_constant_override, or the enum members for an out-of-enum value).

range: Option<(Value, Value)>

A declared [min, max] range (carried, unenforced this phase).

required: Option<Vec<String>>

The required fields (e.g. for missing_field).

Implementations

impl WorkbookToolError

pub fn invalid_input(reason: impl Into<String>) -> Self

invalid_input — an arg-parse / type / enum-membership failure.

pub fn invalid_input_field( field: impl Into<String>, allowed: Vec<String>, ) -> Self

invalid_input for an unknown input FIELD (WR-05). An unknown input key is a bad field, NOT an out-of-set option VALUE, so it shares the invalid_input code with the top-level deny_unknown_fields path. Carries the offending field and the allowed known input keys so the agent can repair the call.

pub fn invalid_enum( field: impl Into<String>, allowed: Vec<String>, reason: impl Into<String>, ) -> Self

invalid_input carrying the closed-enum allowed members (an out-of-enum or non-string-on-string-enum value).

pub fn missing_field(field: impl Into<String>, required: Vec<String>) -> Self

missing_field — a required input is absent.

pub fn unsupported_option( field: impl Into<String>, allowed: Vec<String>, ) -> Self

unsupported_option — an override value out of the supported set (an override naming no manifest cell).

pub fn strict_constant_override( field: impl Into<String>, allowed_variable_keys: Vec<String>, ) -> Self

strict_constant_override — a BA-governed strict constant was supplied as a calculate input. allowed carries the variable-tier override keys the caller MAY set instead.

pub fn unmappable_tool_name(raw: impl Into<String>) -> Self

invalid_tool_name — an output Table name that cannot be sanitized to the MCP tool-name charset ^[a-zA-Z0-9_-]{1,64}$ (empty or all-illegal). A fail-closed reject (T-100-10): an uncallable / charset-illegal tool can never be registered. field carries the offending raw name.

Trait Implementations

impl Clone for WorkbookToolError

fn clone(&self) -> WorkbookToolError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkbookToolError

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

Formats the value using the given formatter.

impl Eq for WorkbookToolError

impl PartialEq for WorkbookToolError

fn eq(&self, other: &WorkbookToolError) -> 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 StructuralPartialEq for WorkbookToolError