antikythera v0.4.0 AntikytheraCore.TerminationManager.State View Source

Link to this section Summary

Functions

Type-aware getter for brokers.

Type-aware setter for brokers.

Type-aware getter for in_service?.

Type-aware setter for in_service?.

Type-aware getter for log_flushed?.

Type-aware setter for log_flushed?.

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

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

Type-aware getter for not_in_service_count.

Type-aware setter for not_in_service_count.

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

Specs

t() :: %AntikytheraCore.TerminationManager.State{
  brokers: Croma.TypeGen.ListOf.Croma.Pid.t(),
  in_service?: Croma.Boolean.t(),
  log_flushed?: Croma.Boolean.t(),
  not_in_service_count: Croma.NonNegInteger.t()
}

Link to this section Functions

Specs

brokers(t()) :: Croma.TypeGen.ListOf.Croma.Pid.t()

Type-aware getter for brokers.

Specs

brokers(t(), Croma.TypeGen.ListOf.Croma.Pid.t()) :: t()

Type-aware setter for brokers.

Specs

in_service?(t()) :: Croma.Boolean.t()

Type-aware getter for in_service?.

Specs

in_service?(t(), Croma.Boolean.t()) :: t()

Type-aware setter for in_service?.

Specs

log_flushed?(t()) :: Croma.Boolean.t()

Type-aware getter for log_flushed?.

Specs

log_flushed?(t(), Croma.Boolean.t()) :: t()

Type-aware setter for log_flushed?.

Specs

new() :: t()

Specs

new(term()) :: Croma.Result.t(t())

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

Specs

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

next(state, now_in_service?)

View Source

Specs

Link to this function

not_in_service_count(state)

View Source

Specs

not_in_service_count(t()) :: Croma.NonNegInteger.t()

Type-aware getter for not_in_service_count.

Link to this function

not_in_service_count(s, field)

View Source

Specs

not_in_service_count(t(), Croma.NonNegInteger.t()) :: t()

Type-aware setter for not_in_service_count.

Specs

update(t(), Dict.t()) :: Croma.Result.t(t())

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

Specs

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.

Specs

valid?(term()) :: boolean()

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