Pi.Protocol.Tool.Eval (pi_bridge v0.6.22)

Structured project eval tool payload.

Summary

Types

t()

Functions

decode(json)

Decodes a JSON string into this struct.

decode!(json)

Decodes a JSON string into this struct, raising on failure.

dump(struct)

Dumps this struct into JSON-shaped data, respecting JSON field names.

from_map(map)

Builds this struct from a decoded JSON map.

from_map!(map)

Builds this struct from a decoded JSON map, raising on failure.

json_schema()

Returns a JSON Schema-compatible schema map.

schema()

Returns a JSON Schema-compatible schema map.

to_map(struct)

Converts this struct into a JSON-shaped map.

Types

t()

@type t() :: %Pi.Protocol.Tool.Eval{
  bindings: [map()],
  display: Pi.Protocol.UI.Display.t() | nil,
  error: String.t() | nil,
  exception: map() | nil,
  io: String.t(),
  kind: String.t(),
  parts: [Pi.Protocol.Tool.OutputPart.t()],
  result: String.t() | nil,
  state: map() | nil,
  text: String.t()
}

Functions

decode(json)

Decodes a JSON string into this struct.

decode!(json)

Decodes a JSON string into this struct, raising on failure.

dump(struct)

Dumps this struct into JSON-shaped data, respecting JSON field names.

from_map(map)

Builds this struct from a decoded JSON map.

from_map!(map)

Builds this struct from a decoded JSON map, raising on failure.

json_schema()

Returns a JSON Schema-compatible schema map.

schema()

Returns a JSON Schema-compatible schema map.

to_map(struct)

Converts this struct into a JSON-shaped map.