Summary

cast_result()

validator()

types()

all()

Returns all registered plugins including DefaultPlugin.

Finds plugin that support the given type. Returns nil if no plugins support the type.

Types

@type cast_result() :: {:ok, any()} | {:error, binary() | [binary()]}

@type validate_result() ::
  :ok | :error | boolean() | {:ok, any()} | {:error, binary() | [binary()]}

@type validator() :: {atom(), term()}

(optional)

@callback cast(type :: atom(), value :: any(), opts :: keyword()) :: cast_result()

@callback types() :: [atom()]

(optional)

@callback validate(
  type :: atom(),
  value :: any(),
  validator :: validator(),
  opts :: keyword()
) ::
  validate_result()

@spec all() :: [module()]

Returns all registered plugins including DefaultPlugin.

@spec find_for_type(atom()) :: [module()] | nil

Finds plugin that support the given type. Returns nil if no plugins support the type.