HostKit.Package.Lock (host_kit v0.1.0-beta.1)

JSON lock file for resolved target package names.

Summary

t()

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.

load(path)

load!(path)

save(path, lock)

schema()

Returns a JSON Schema-compatible schema map.

to_map(struct)

Converts this struct into a JSON-shaped map.

@type t() :: %HostKit.Package.Lock{
  packages: %{required(String.t()) => String.t()},
  target: String.t() | nil,
  version: pos_integer()
}

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.

@spec get(t(), atom() | String.t(), String.t() | Regex.t()) ::
  {:ok, String.t()} | :error | {:error, term()}

Returns a JSON Schema-compatible schema map.

@spec load(Path.t()) :: {:ok, t()} | {:error, term()}

@spec load!(Path.t()) :: t()

@spec put(t(), atom() | String.t(), String.t(), String.t()) :: t()

@spec save(Path.t(), t()) :: :ok | {:error, term()}