Pi.CodeMap.Hotspot (pi_bridge v0.6.22)

Copy Markdown View Source

A Reach hotspot finding for a function.

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.Hotspot{
  branches: non_neg_integer() | nil,
  callers: non_neg_integer() | nil,
  clauses: [term()],
  display_function: String.t() | nil,
  file: String.t() | nil,
  function: String.t() | nil,
  line: non_neg_integer() | nil,
  module: String.t() | nil,
  score: number() | 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.