Struct ToolError 

pub struct ToolError {
    pub code: ErrorCode,
    pub message: String,
    pub exit_code: Option<i32>,
    pub stderr: Option<String>,
    pub status: Option<u16>,
    pub hint: Option<String>,
}

A failed tool call, as the client sees it.

Every string field has already been through redact by the time it is here: the constructors do it, so a caller cannot forget.

Fields

code: ErrorCode

message: String

exit_code: Option<i32>

The process exit code, when a process is what failed.

stderr: Option<String>

What the process wrote to its standard error, trimmed and redacted.

status: Option<u16>

The HTTP status, when the control plane is what failed.

hint: Option<String>

What the caller can do about it. Present on every code where the fix is something the caller or operator controls.

Implementations

impl ToolError

pub fn new(code: ErrorCode, message: impl Into<String>) -> Self

The general constructor. Prefer the named ones below; this exists for the paths that compute their own code.

pub fn with_exit_code(self, exit_code: i32) -> Self

pub fn with_stderr(self, stderr: impl AsRef<str>) -> Self

pub fn with_status(self, status: u16) -> Self

pub fn with_hint(self, hint: impl Into<String>) -> Self

pub fn cli_failed(argv0: &str, exit_code: Option<i32>, stderr: &str) -> Self

The tailscale binary exited non-zero.

The code is optional because a process killed by a signal has none, and saying so is more use to the caller than inventing a number.

pub fn api_error(status: u16, body: &str) -> Self

The control plane returned a status we do not model more precisely.

pub fn timeout(what: &str, seconds: u64, printed: &str) -> Self

A command that did not finish. printed is whatever it had said before it was stopped, which for a command that waits on someone else is usually the whole explanation.

pub fn not_permitted(tool: &str, needs: &str) -> Self

A tool was reached that this server is not permitted to run. In the normal case such tools are hidden rather than refused, so this fires when a client calls a name it did not get from the listing.

pub fn needs_operator(stderr: &str) -> Self

pub fn unsupported_version(tool: &str, needs: &str, found: &str) -> Self

pub fn backend_unavailable(what: &str, why: &str) -> Self

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

pub fn unsupported_platform(tool: &str, platform: &str) -> Self

pub fn not_found(what: &str) -> Self

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

A version this caller holds is no longer the current one. Carries 409 the way not_found carries 404: a client that branches on the status should not have to know which of the two this server chose to name.

pub fn rate_limited(retry_after: Option<u64>) -> Self

pub fn result_too_large(bytes: usize, cap: usize) -> Self

pub fn confirmation_required(tool: &str, consequence: &str) -> Self

pub fn to_value(&self) -> Value

The wire form: what a client receives as the structured content of a failed call. Falls back to a bare code if serialisation ever fails, so that a caller always gets something it can branch on.

Trait Implementations

impl Clone for ToolError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolError

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

Formats the value using the given formatter.

impl Display for ToolError

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

Formats the value using the given formatter.

impl Eq for ToolError

impl Error for ToolError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<ApiError> for ToolError

A control-plane failure, in the vocabulary a client can branch on.

tailscale_rest deliberately names its variants for what happened rather than for what a caller should be told, so that the crate can be used without this server’s error model. This is the other half of that arrangement, and the one place the translation happens: every tailnet tool reaches the control plane through ?, so nothing has to remember to call it.

fn from(error: ApiError) -> Self

Converts to this type from the input type.

impl PartialEq for ToolError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolError

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 ToolError