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

Arguments for project eval tools.

Summary

Types

mode()

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

mode()

@type mode() :: :trusted | :sandbox

t()

@type t() :: %Pi.Protocol.Tool.EvalRequest{
  code: String.t(),
  mode: mode(),
  reload: boolean(),
  restore_path: String.t() | nil,
  session_id: String.t() | nil,
  state_path: String.t() | nil,
  timeout: non_neg_integer() | nil
}

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.