antikythera v0.2.0 AntikytheraCore.Alert.HandlerState View Source

Link to this section 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

Link to this section Types

Link to this type t() View Source
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()}

Link to this section Functions

Link to this function busy?(handler_state) View Source
busy?(t()) :: Croma.Boolean.t()

Type-aware getter for busy?.

Type-aware setter for busy?.

Link to this function handler_module(handler_state) View Source
handler_module(t()) :: Croma.Atom.t()

Type-aware getter for handler_module.

Link to this function handler_module(s, field) View Source
handler_module(t(), Croma.Atom.t()) :: t()

Type-aware setter for handler_module.

Link to this function message_buffer(handler_state) View Source
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
message_buffer(t(), Croma.TypeGen.ListOf.AntikytheraCore.Alert.Message.t()) :: t()

Type-aware setter for message_buffer.

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

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
otp_app_name(t()) :: Croma.Atom.t()

Type-aware getter for otp_app_name.

Link to this function otp_app_name(s, field) View Source
otp_app_name(t(), Croma.Atom.t()) :: t()

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

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.