View Source AntikytheraCore.TmpdirTracker.State (antikythera v0.5.1)

Summary

Functions

Type-aware getter for gear_tmp_dir.

Type-aware setter for gear_tmp_dir.

Type-aware getter for map.

Type-aware setter for map.

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

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

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}.

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

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

Types

@type t() :: %AntikytheraCore.TmpdirTracker.State{
  gear_tmp_dir: Croma.String.t(),
  map: AntikytheraCore.TmpdirTracker.State.Map.t()
}

Functions

@spec gear_tmp_dir(t()) :: Croma.String.t()

Type-aware getter for gear_tmp_dir.

@spec gear_tmp_dir(t(), Croma.String.t()) :: t()

Type-aware setter for gear_tmp_dir.

Type-aware getter for map.

Type-aware setter for map.

@spec 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
@spec 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.

@spec 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}.

@spec 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.

@spec valid?(term()) :: boolean()

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