Pi.CodeMap.Reflection (pi_bridge v0.6.22)

Copy Markdown View Source

Post-edit semantic reflection result.

Summary

Functions

Decodes a JSON string into this struct.

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

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

Builds this struct from a decoded JSON map.

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

Returns a JSON Schema-compatible schema map.

Returns a JSON Schema-compatible schema map.

Converts this struct into a JSON-shaped map.

Types

t()

@type t() :: %Pi.CodeMap.Reflection{
  boundaries: [Pi.CodeMap.Boundary.t()],
  changed_functions: [Pi.CodeMap.FunctionRef.t()],
  command: String.t(),
  contexts: [map()],
  hotspots: [Pi.CodeMap.Hotspot.t()],
  paths: [String.t()],
  recommendation: String.t() | nil,
  smells: [Pi.CodeMap.Smell.t()],
  summary: map()
}

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.