View Source AntikytheraCore.Alert.HandlerState (antikythera v0.5.1)

Summary

Functions

Type-aware getter for busy?.

Type-aware setter for busy?.

Type-aware getter for handler_module.

Type-aware setter for handler_module.

Type-aware getter for message_buffer.

Type-aware setter for message_buffer.

Creates a new instance of AntikytheraCore.Alert.HandlerState by using the given dict.

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

Type-aware getter for otp_app_name.

Type-aware setter for otp_app_name.

Updates an existing instance of AntikytheraCore.Alert.HandlerState 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.Alert.HandlerState{
  busy?: Croma.Boolean.t(),
  handler_module: Croma.Atom.t(),
  message_buffer: Croma.TypeGen.ListOf.AntikytheraCore.Alert.Message.t(),
  otp_app_name: Croma.Atom.t()
}

Functions

@spec busy?(t()) :: Croma.Boolean.t()

Type-aware getter for busy?.

@spec busy?(t(), Croma.Boolean.t()) :: t()

Type-aware setter for busy?.

Link to this function

handler_module(handler_state)

View Source
@spec handler_module(t()) :: Croma.Atom.t()

Type-aware getter for handler_module.

Link to this function

handler_module(s, field)

View Source
@spec handler_module(t(), Croma.Atom.t()) :: t()

Type-aware setter for handler_module.

Link to this function

message_buffer(handler_state)

View Source
@spec message_buffer(t()) :: Croma.TypeGen.ListOf.AntikytheraCore.Alert.Message.t()

Type-aware getter for message_buffer.

Link to this function

message_buffer(s, field)

View Source
@spec message_buffer(t(), Croma.TypeGen.ListOf.AntikytheraCore.Alert.Message.t()) ::
  t()

Type-aware setter for message_buffer.

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

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

Link to this function

otp_app_name(handler_state)

View Source
@spec otp_app_name(t()) :: Croma.Atom.t()

Type-aware getter for otp_app_name.

@spec otp_app_name(t(), Croma.Atom.t()) :: t()

Type-aware setter for otp_app_name.

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

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