MscmpSystError.Types.Context (mscmp_syst_error v0.1.0)

Defines the Context data which a MscmpSystError exception can be associated with in a standard way.

Note that one should not expect that any given exception will provide context data, but it is expected that any exception which does provide context data will use this module's definitions and structure.

Summary

Types

t()

Represents the context associated with a MscmpSystError exception.

Types

t()

@type t() :: %MscmpSystError.Types.Context{
  origin: {module(), function(), arity()} | nil,
  parameters: map() | nil,
  supporting_data: term() | nil
}

Represents the context associated with a MscmpSystError exception.

Attributes

:parameters: A map of function parameters and their values which were in effect when the error was encountered.
:origin: A tuple containing the module, function, and arity where the error originated, or nil if unknown.
:supporting_data: Any additional data that might be relevant to the error or exception, or nil if not provided.