antikythera v0.3.0 AntikytheraCore.ReductionLogWriter.State View Source

Link to this section Summary

Functions

Type-aware getter for empty?.

Type-aware setter for empty?.

Type-aware getter for file_handle.

Type-aware setter for file_handle.

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

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

Type-aware getter for reduction.

Type-aware setter for reduction.

Type-aware getter for timer.

Type-aware setter for timer.

Updates an existing instance of AntikytheraCore.ReductionLogWriter.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.

Link to this section Types

Link to this type

t()

View Source
t() :: %AntikytheraCore.ReductionLogWriter.State{
  empty?: Croma.Boolean.t(),
  file_handle: Croma.Tuple.t(),
  reduction: Croma.Map.t(),
  timer: Croma.Reference.t()
}

Link to this section Functions

Type-aware getter for empty?.

Link to this function

empty?(s, field)

View Source
empty?(t(), Croma.Boolean.t()) :: t()

Type-aware setter for empty?.

Link to this function

file_handle(state)

View Source
file_handle(t()) :: Croma.Tuple.t()

Type-aware getter for file_handle.

Link to this function

file_handle(s, field)

View Source
file_handle(t(), Croma.Tuple.t()) :: t()

Type-aware setter for file_handle.

Creates a new instance of AntikytheraCore.ReductionLogWriter.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

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

reduction(state)

View Source
reduction(t()) :: Croma.Map.t()

Type-aware getter for reduction.

Link to this function

reduction(s, field)

View Source
reduction(t(), Croma.Map.t()) :: t()

Type-aware setter for reduction.

Type-aware getter for timer.

Type-aware setter for timer.

Updates an existing instance of AntikytheraCore.ReductionLogWriter.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.

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