Module cuttlefish_datatypes

Data Types

datatype()

datatype() = integer | string | atom | boolean | file | directory | flag | {flag, atom(), atom()} | {flag, {atom(), term()}, {atom(), term()}} | {enum, [atom()]} | ip | fqdn | domain_socket | {duration, cuttlefish_duration:time_unit()} | {duration, cuttlefish_duration:time_unit(), [numeric_constraint()] | numeric_shortcut()} | bytesize | {bytesize, [numeric_constraint()] | numeric_shortcut()} | {percent, integer} | {percent, float} | percent | port | byte | {integer, [numeric_constraint()] | numeric_shortcut()} | {float, [numeric_constraint()] | numeric_shortcut()} | float | tagged_string | regex | uri | {uri, [atom()]} | {list, datatype()}

datatype_list()

datatype_list() = [datatype() | extended()]

extended()

extended() = {integer, integer()} | {string, string()} | {binary, binary()} | {file, file:filename()} | {directory, file:filename()} | {atom, atom()} | {ip, {string(), integer()}} | {domain_socket, {string(), integer()}} | {{duration, cuttlefish_duration:time_unit()}, string()} | {bytesize, string()} | {{percent, integer}, integer()} | {{percent, float}, float()} | {float, float()} | {tagged_string, string()} | {tagged_binary, string()}

numeric_constraint()

numeric_constraint() = {min, number()} | {max, number()} | {gt, number()} | {lt, number()} | numeric_shortcut() | allow_infinity | {validator, validator_fun()} | {validator, string()}

numeric_shortcut()

numeric_shortcut() = non_negative | positive

validator_fun()

validator_fun() = fun((term()) -> boolean())

Function Index

constraint_validator_refs/1
extended_from/1
from_string/2
is_extended/1
is_supported/1
is_valid_list/1
resolve_constraint_validators/2
to_string/2

Function Details

constraint_validator_refs/1

constraint_validator_refs(DT::datatype() | [datatype()]) -> [string()]

extended_from/1

extended_from(Other::extended()) -> datatype()

from_string/2

from_string(Atom::term(), Type::datatype()) -> term() | cuttlefish_error:error()

is_extended/1

is_extended(X1::any()) -> boolean()

is_supported/1

is_supported(X1::any()) -> boolean()

is_valid_list/1

is_valid_list(NotList::any()) -> boolean()

resolve_constraint_validators/2

resolve_constraint_validators(DT::datatype() | [datatype()], Lookup::fun((string()) -> {ok, validator_fun()} | not_found)) -> datatype() | [datatype()]

to_string/2

to_string(Atom::term(), Type::datatype()) -> string() | cuttlefish_error:error()


Generated by EDoc