Toolnexus.ToolResult (toolnexus v0.9.4)

Uniform tool result (SPEC §1). metadata.pending carrying a Request = suspension (§10).

Summary

t()

error(text)

Convenience: an error result with the given text.

ok(text)

Convenience: a success result with the given text.

pending?(arg1)

True when this result is a §10 suspension (metadata.pending is a Request).

@type t() :: %Toolnexus.ToolResult{
  is_error: boolean(),
  metadata: map() | nil,
  output: String.t()
}

@spec error(String.t()) :: t()

Convenience: an error result with the given text.

@spec ok(String.t()) :: t()

Convenience: a success result with the given text.

@spec pending?(t()) :: boolean()

True when this result is a §10 suspension (metadata.pending is a Request).