Pi.Protocol.UIEvent (pi_bridge v0.6.22)

Copy Markdown View Source

BEAM-to-Pi UI event envelope.

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.UIEvent{
  current: non_neg_integer() | nil,
  key: atom() | String.t() | nil,
  level: atom() | nil,
  lines: [String.t()] | nil,
  message: String.t() | nil,
  op: atom(),
  placement: atom() | nil,
  text: String.t() | nil,
  title: String.t() | nil,
  total: non_neg_integer() | nil,
  type: atom()
}

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.