antikythera

v0.2.0

antikythera v0.2.0 AntikytheraCore.TmpdirTracker.State View Source

Link to this section Summary

Types

t()

Functions

gear_tmp_dir(state)

Type-aware getter for gear_tmp_dir

gear_tmp_dir(s, field)

Type-aware setter for gear_tmp_dir

map(state)

Type-aware getter for map

map(s, field)

Type-aware setter for map

new(dict)

Creates a new instance of AntikytheraCore.TmpdirTracker.State by using the given dict

new!(dict)

A variant of new/1 which returns t or raise if validation fails

update(s, dict)

Updates an existing instance of AntikytheraCore.TmpdirTracker.State with the given dict. The values in the dict are validated by each field’s valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}

update!(s, dict)

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1

valid?(value)

Checks if the given value belongs to t/0 or not

Link to this section Types

Link to this type t() View Source 
t() :: %AntikytheraCore.TmpdirTracker.State{gear_tmp_dir: Croma.String.t(), map: AntikytheraCore.TmpdirTracker.State.Map.t()}

Link to this section Functions

Link to this function gear_tmp_dir(state) View Source 
gear_tmp_dir(t()) :: Croma.String.t()

Type-aware getter for gear_tmp_dir.

Link to this function gear_tmp_dir(s, field) View Source 
gear_tmp_dir(t(), Croma.String.t()) :: t()

Type-aware setter for gear_tmp_dir.

Link to this function map(s, field) View Source 
map(t(), AntikytheraCore.TmpdirTracker.State.Map.t()) :: t()

Type-aware setter for map.

Link to this function new(dict) View Source 
new(term()) :: Croma.Result.t(t())

Creates a new instance of AntikytheraCore.TmpdirTracker.State by using the given dict.

Returns {:ok, valid_struct} or {:error, reason}.

The values in the dict are validated by each field’s valid?/1 function. If the value was invalid, it will be passed to new/1 of the field

For missing fields, followings will be tried:

  • default/0 of each field type
  • new/1 of each field type, with empty map as input
Link to this function new!(dict) View Source 
new!(term()) :: t()

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

Link to this function update(s, dict) View Source 
update(t(), Dict.t()) :: Croma.Result.t(t())

Updates an existing instance of AntikytheraCore.TmpdirTracker.State with the given dict. The values in the dict are validated by each field’s valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

Link to this function update!(s, dict) View Source 
update!(t(), Dict.t()) :: t()

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

Link to this function valid?(value) View Source 
valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.