antikythera v0.4.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
Specs
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
Specs
busy?(t()) :: Croma.Boolean.t()
Type-aware getter for busy?.
Specs
busy?(t(), Croma.Boolean.t()) :: t()
Type-aware setter for busy?.
Specs
handler_module(t()) :: Croma.Atom.t()
Type-aware getter for handler_module.
Specs
handler_module(t(), Croma.Atom.t()) :: t()
Type-aware setter for handler_module.
Specs
message_buffer(t()) :: Croma.TypeGen.ListOf.AntikytheraCore.Alert.Message.t()
Type-aware getter for message_buffer.
Specs
Type-aware setter for message_buffer.
Specs
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/0of each field typenew/1of each field type, with empty map as input
Specs
A variant of new/1 which returns t or raise if validation fails.
In other words, new/1 followed by Croma.Result.get!/1.
Specs
otp_app_name(t()) :: Croma.Atom.t()
Type-aware getter for otp_app_name.
Specs
otp_app_name(t(), Croma.Atom.t()) :: t()
Type-aware setter for otp_app_name.
Specs
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}.
Specs
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
Checks if the given value belongs to t/0 or not.