Module cuttlefish_mapping

Data Types
Function Index
Function Details

Data Types

mapping()

mapping() = #mapping{variable = cuttlefish_variable:variable(), mapping = string(), default = term(), commented = term(), datatype = cuttlefish_datatypes:datatype_list(), level = basic | intermediate | advanced, doc = list(), include_default = string() | undefined, new_conf_value = string() | undefined, validators = [string()], is_merge = boolean(), see = [cuttlefish_variable:variable()], hidden = boolean()}

raw_mapping()

raw_mapping() = {mapping, string(), string(), [proplists:property()]}

Function Index

commented/1
datatype/1
default/1
doc/1
has_default/1
hidden/1
include_default/1
is_fuzzy_variable/1
is_mapping/1
level/1
mapping/1
new_conf_value/1
parse/1
parse_and_merge/2
remove_all_but_first/2
replace/2
see/1
validators/1
validators/2
variable/1

Function Details

commented/1

commented(M::mapping()) -> term()

datatype/1

datatype(M::mapping()) -> cuttlefish_datatypes:datatype_list()

default/1

default(M::mapping()) -> term()

doc/1

doc(M::mapping()) -> [string()]

has_default/1

has_default(MappingRecord::mapping()) -> boolean()

hidden/1

hidden(M::mapping()) -> boolean()

include_default/1

include_default(M::mapping()) -> string() | undefined

is_fuzzy_variable/1

is_fuzzy_variable(Mapping::mapping()) -> boolean()

is_mapping/1

is_mapping(M::any()) -> boolean()

level/1

level(M::mapping()) -> basic | intermediate | advanced

mapping/1

mapping(M::mapping()) -> string()

new_conf_value/1

new_conf_value(M::mapping()) -> string() | undefined

parse/1

parse(X::raw_mapping()) -> mapping() | cuttlefish_error:error()

parse_and_merge/2

parse_and_merge(MappingSource::raw_mapping(), Mappings::[mapping()]) -> [mapping()]

remove_all_but_first/2

remove_all_but_first(MappingName::string(), Mappings::[mapping()]) -> [mapping()]

replace/2

replace(Mapping::mapping(), ListOfMappings::[mapping()]) -> [mapping()]

see/1

see(M::mapping()) -> [cuttlefish_variable:variable()]

validators/1

validators(M::mapping()) -> [string()]

validators/2

validators(M::mapping(), Validators::[cuttlefish_validator:validator()]) -> [cuttlefish_validator:validator()]

variable/1

variable(M::mapping()) -> [string()]

Generated by EDoc