Module cuttlefish_datatypes

Data Types

datatype()

datatype() = integer | string | atom | file | directory | flag | {flag, atom(), atom()} | {flag, {atom(), term()}, {atom(), term()}} | {enum, [atom()]} | ip | fqdn | domain_socket | {duration, cuttlefish_duration:time_unit()} | bytesize | {percent, integer} | {percent, float} | float | {list, datatype()}

datatype_list()

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

extended()

extended() = {integer, integer()} | {string, string()} | {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()}

Function Index

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

Function Details

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()

to_string/2

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


Generated by EDoc