Enum ToolErrorInfo 

#[non_exhaustive]
pub enum ToolErrorInfo {
    Text {
        message: String,
    },
    Json {
        value: JsonValue,
    },
}

Serializable description of a tool error.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text

A textual error.

Fields

message: String

The message.

Json

A structured error payload.

Fields

value: JsonValue

The payload.

Implementations

impl ToolErrorInfo

pub fn text(message: impl Into<String>) -> Self

Creates a textual error.

pub fn to_json_value(&self) -> JsonValue

The error as a JSON value (text becomes a JSON string).

pub fn message(&self) -> String

A human-readable message.

Trait Implementations

impl Clone for ToolErrorInfo

fn clone(&self) -> ToolErrorInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolErrorInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolErrorInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ToolErrorInfo

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

Formats the value using the given formatter.

impl From<&ToolError> for ToolErrorInfo

fn from(error: &ToolError) -> Self

Converts to this type from the input type.

impl PartialEq for ToolErrorInfo

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolErrorInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolErrorInfo