View Source GuardedStruct.Messages behaviour (GuardedStruct v0.0.4)

This module is used to define the messages that are used in the guarded_struct library. You can define your own messages by creating a module that uses this module and implements the callbacks defined in this module. It can be used to define messages in multiple languages like using Gettext.

Usage

defmodule GuardedStruct.Your.Messages do
  use GuardedStruct.Messages
  import MyAppWeb.Gettext

  def required_fields(), do: gettext("Please submit required fields.")
end

Remember to add message_backend: GuardedStruct.Your.Messages to your configuration.

config :guarded_struct, message_backend: GuardedStruct.Your.Messages

Summary

Types

message()

Callbacks

authorized_fields()

builder()

check_dependent_keys({})

convert_enum_output(any)

custom(any)

date_binary(any)

datetime(any)

domain_field_status(any)

either(any)

email(any)

email_r(any)

enum(any)

equal(any)

field(any)

field_type(any)

force_domain_field_status(any)

full_name(any)

ipv4(any)

is_type({})

list_builder()

list_builder_field_exception()

list_builder_type()

location(any)

location_url(any)

max_len(any)

max_len_binary({})

max_len_integer({})

max_len_list({})

max_len_range({})

message_exception()

message_exception(any)

min_len(any)

min_len_binary({})

min_len_integer({})

min_len_list({})

min_len_range({})

not_empty(any)

not_empty_binary(any)

not_empty_list(any)

not_empty_map(any)

not_empty_string(any)

not_flatten_empty(any)

not_flatten_empty_item(any)

parser_field_value()

queue(any)

range(any)

regex(any)

register_struct()

required_fields()

some_string_float(any)

some_string_integer(any)

string_boolean(any)

string_float(any)

string_integer(any)

tell(any)

unsupported_conditional_field()

url(any)

url_gethostbyname(any)

url_host(any)

url_scheme(any)

username(any)

uuid(any)

validate_unexpected(any)

Functions

authorized_fields()

builder()

check_dependent_keys(arg)

convert_enum_output(field)

custom(field)

date_binary(field)

datetime(field)

domain_field_status(key)

either(field)

email(field)

email_r(field)

enum(field)

equal(field)

field(name)

field_type(name)

force_domain_field_status(key)

full_name(field)

ipv4(field)

is_type(arg)

list_builder()

list_builder_field_exception()

list_builder_type()

location(field)

location_url(field)

max_len(field)

max_len_binary(arg)

max_len_integer(arg)

max_len_list(arg)

max_len_range(arg)

message_exception()

message_exception(exception)

min_len(field)

min_len_binary(arg)

min_len_integer(arg)

min_len_list(arg)

min_len_range(arg)

not_empty(field)

not_empty_binary(field)

not_empty_list(field)

not_empty_map(field)

not_empty_string(field)

not_flatten_empty(field)

not_flatten_empty_item(field)

parser_field_value()

queue(field)

range(field)

regex(field)

register_struct()

required_fields()

some_string_float(field)

some_string_integer(field)

string_boolean(field)

string_float(field)

string_integer(field)

tell(field)

translated_message(fn_atom)

translated_message(fn_atom, options)

unsupported_conditional_field()

url(field)

url_gethostbyname(field)

url_host(field)

url_scheme(field)

username(field)

uuid(field)

validate_unexpected(field)

Types

message()

@type message() :: binary()

Callbacks

authorized_fields()

(optional)

@callback authorized_fields() :: message()

builder()

(optional)

@callback builder() :: message()

check_dependent_keys({})

(optional)

@callback check_dependent_keys({any(), any()}) :: message()

convert_enum_output(any)

(optional)

@callback convert_enum_output(any()) :: message()

custom(any)

(optional)

@callback custom(any()) :: message()

date_binary(any)

(optional)

@callback date_binary(any()) :: message()

datetime(any)

(optional)

@callback datetime(any()) :: message()

domain_field_status(any)

(optional)

@callback domain_field_status(any()) :: message()

either(any)

(optional)

@callback either(any()) :: message()

email(any)

(optional)

@callback email(any()) :: message()

email_r(any)

(optional)

@callback email_r(any()) :: message()

enum(any)

(optional)

@callback enum(any()) :: message()

equal(any)

(optional)

@callback equal(any()) :: message()

field(any)

(optional)

@callback field(any()) :: message()

field_type(any)

(optional)

@callback field_type(any()) :: message()

force_domain_field_status(any)

(optional)

@callback force_domain_field_status(any()) :: message()

full_name(any)

(optional)

@callback full_name(any()) :: message()

ipv4(any)

(optional)

@callback ipv4(any()) :: message()

is_type({})

(optional)

@callback is_type({any(), any()}) :: message()

list_builder()

(optional)

@callback list_builder() :: message()

list_builder_field_exception()

(optional)

@callback list_builder_field_exception() :: message()

list_builder_type()

(optional)

@callback list_builder_type() :: message()

location(any)

(optional)

@callback location(any()) :: message()

location_url(any)

(optional)

@callback location_url(any()) :: message()

max_len(any)

(optional)

@callback max_len(any()) :: message()

max_len_binary({})

(optional)

@callback max_len_binary({any(), any()}) :: message()

max_len_integer({})

(optional)

@callback max_len_integer({any(), any()}) :: message()

max_len_list({})

(optional)

@callback max_len_list({any(), any()}) :: message()

max_len_range({})

(optional)

@callback max_len_range({any(), any()}) :: message()

message_exception()

(optional)

@callback message_exception() :: message()

message_exception(any)

(optional)

@callback message_exception(any()) :: message()

min_len(any)

(optional)

@callback min_len(any()) :: message()

min_len_binary({})

(optional)

@callback min_len_binary({any(), any()}) :: message()

min_len_integer({})

(optional)

@callback min_len_integer({any(), any()}) :: message()

min_len_list({})

(optional)

@callback min_len_list({any(), any()}) :: message()

min_len_range({})

(optional)

@callback min_len_range({any(), any()}) :: message()

not_empty(any)

(optional)

@callback not_empty(any()) :: message()

not_empty_binary(any)

(optional)

@callback not_empty_binary(any()) :: message()

not_empty_list(any)

(optional)

@callback not_empty_list(any()) :: message()

not_empty_map(any)

(optional)

@callback not_empty_map(any()) :: message()

not_empty_string(any)

(optional)

@callback not_empty_string(any()) :: message()

not_flatten_empty(any)

(optional)

@callback not_flatten_empty(any()) :: message()

not_flatten_empty_item(any)

(optional)

@callback not_flatten_empty_item(any()) :: message()

parser_field_value()

(optional)

@callback parser_field_value() :: message()

queue(any)

(optional)

@callback queue(any()) :: message()

range(any)

(optional)

@callback range(any()) :: message()

regex(any)

(optional)

@callback regex(any()) :: message()

register_struct()

(optional)

@callback register_struct() :: message()

required_fields()

(optional)

@callback required_fields() :: message()

some_string_float(any)

(optional)

@callback some_string_float(any()) :: message()

some_string_integer(any)

(optional)

@callback some_string_integer(any()) :: message()

string_boolean(any)

(optional)

@callback string_boolean(any()) :: message()

string_float(any)

(optional)

@callback string_float(any()) :: message()

string_integer(any)

(optional)

@callback string_integer(any()) :: message()

tell(any)

(optional)

@callback tell(any()) :: message()

unsupported_conditional_field()

(optional)

@callback unsupported_conditional_field() :: message()

url(any)

(optional)

@callback url(any()) :: message()

url_gethostbyname(any)

(optional)

@callback url_gethostbyname(any()) :: message()

url_host(any)

(optional)

@callback url_host(any()) :: message()

url_scheme(any)

(optional)

@callback url_scheme(any()) :: message()

username(any)

(optional)

@callback username(any()) :: message()

uuid(any)

(optional)

@callback uuid(any()) :: message()

validate_unexpected(any)

(optional)

@callback validate_unexpected(any()) :: message()