View Source Matcha.Error behaviour (Matcha v0.1.10)

Standard behaviour for Matcha errors.

Link to this section Summary

error_problem()

message()

problem()

problems()

Generates the "prelude" text for errors in the struct this error handles into a string displayable in an error message.

Converts the struct this error handles into a string displayable in an error message.

@type error_problem() :: {:error, message()}

@type message() :: binary() | charlist()

@type problem() :: error_problem() | warning_problem()

@type problems() :: [problem()]

@type warning_problem() :: {:warning, message()}

@callback format_prelude(struct()) :: binary()

Generates the "prelude" text for errors in the struct this error handles into a string displayable in an error message.

@callback format_source(struct()) :: binary()

Converts the struct this error handles into a string displayable in an error message.