RedactEx.Algorithms.Algorithm behaviour (RedactEx v0.1.8)

View Source

Behaviour to implement for an algorithm to be configured as a redacting algorithm when using RedactEx

Summary

Types

t()

Callbacks

generate_ast(configuration)

Returns the AST of the implementing algorithm, given whatever supported configuration

parse_extra_configuration!(configuration)

Parses additional configuration at compile time for given algorithm. Configuration will be kept in Context's extra field Shall return any configuration (eventually) readable by generate_ast and generate_fallback_ast

Functions

implemented_by?(module)

Check that this behaviour is implemented in given module

Types

t()

@type t() :: module()

Callbacks

generate_ast(configuration)

@callback generate_ast(configuration :: any()) :: Macro.t()

Returns the AST of the implementing algorithm, given whatever supported configuration

parse_extra_configuration!(configuration)

@callback parse_extra_configuration!(configuration :: any()) :: any() | no_return()

Parses additional configuration at compile time for given algorithm. Configuration will be kept in Context's extra field Shall return any configuration (eventually) readable by generate_ast and generate_fallback_ast

The function shall raise in case of errors

Functions

implemented_by?(module)

@spec implemented_by?(module()) :: boolean()

Check that this behaviour is implemented in given module