HostKit.Package.Repology.Record (host_kit v0.1.0-beta.1)

Copy Markdown View Source

Package record returned by the Repology API.

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

status()

@type status() :: String.t()

t()

@type t() :: %HostKit.Package.Repology.Record{
  binname: String.t() | nil,
  binnames: [String.t()],
  categories: [String.t()],
  licenses: [String.t()],
  maintainers: [String.t()],
  meta: map(),
  origversion: String.t() | nil,
  repo: String.t(),
  srcname: String.t() | nil,
  status: status() | nil,
  subrepo: String.t() | nil,
  summary: String.t() | nil,
  version: String.t(),
  visiblename: String.t() | 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.