Enum ToolErrorKind 

#[non_exhaustive]
pub enum ToolErrorKind {
    VersionConflict {
        path: String,
        expected: String,
        actual: Option<String>,
    },
    RemoteGitConflict {
        code: String,
        message: String,
    },
    NotFound {
        path: String,
    },
    InvalidArgument {
        message: String,
    },
    Unsupported {
        message: String,
    },
    Timeout {
        op: String,
        duration_ms: u64,
    },
}

Structured discriminant for tool failures.

This is the SDK-facing counterpart of WorkspaceError (and any future typed error sources). The Rust trait surface returns typed enums; this struct is what survives the trip through ToolOutput → ToolResult → ToolCallResult → SDK boundary so JS / Python callers can do match on the kind instead of regex-matching the human-readable output string.

Serializes to JSON with a type discriminator, e.g.:

{ "type": "version_conflict", "path": "doc.md", "expected": "etag-1", "actual": "etag-2" }

#[non_exhaustive] so adding a new kind is a minor-version change.

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.

VersionConflict

Compare-and-swap write rejected by the backend because the file changed since the caller read it. Originates from WorkspaceError::VersionConflict on the S3 / future versioning backends.

Fields

path: String

expected: String

actual: Option<String>

RemoteGitConflict

Remote git server returned a typed 409 / 422 conflict code such as BRANCH_EXISTS or WORKING_TREE_DIRTY.

Fields

code: String

message: String

NotFound

Operation referenced a path that does not exist.

Fields

path: String

InvalidArgument

Caller passed an argument the tool / backend cannot honour (malformed pattern, parent-traversal path, …).

Fields

message: String

Unsupported

The backend explicitly does not support this operation (e.g. worktree on a remote-git workspace).

Fields

message: String

Timeout

The operation’s outer timeout fired before the backend responded.

Fields

op: String

duration_ms: u64

Implementations

impl ToolErrorKind

pub fn from_workspace_error(err: &WorkspaceError) -> Option<Self>

Map a WorkspaceError into the corresponding SDK-visible kind. Backend variants that don’t fit a dedicated ToolErrorKind (currently Backend(_)) return None; the caller then surfaces only the human-readable message.

Trait Implementations

impl Clone for ToolErrorKind

fn clone(&self) -> ToolErrorKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolErrorKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolErrorKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolErrorKind

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ToolErrorKind

impl StructuralPartialEq for ToolErrorKind