Module clique_parser

Data Types
Function Index
Function Details

Data Types

flags()

flags() = [{string() | char(), term()}]

spec() = #clique_spec{key = atom(), name = string(), shortname = char() | undefined, datatype = cuttlefish_datatypes:datatype() | undefined, validator = fun((term()) -> ok | err()) | undefined, typecast = fun((string()) -> err() | term()) | undefined}

Function Index

extract_global_flags/1	Extracts a list of globally applicable flags (e.g.
is_not_flag/1
is_not_kv_arg/1
parse/1
parse_flags/1
validate/1
validate_flags/2

Function Details

extract_global_flags/1

extract_global_flags(E::err()) -> err()

extract_global_flags(E::{tuple(), proplist(), flags()}) -> {tuple(), proplist(), flags(), flags()}

Extracts a list of globally applicable flags (e.g. --help) from the the original command.

is_not_flag/1

is_not_flag(Str::string()) -> boolean()

is_not_kv_arg/1

is_not_kv_arg(Str::string()) -> boolean()

parse/1

parse(E::err()) -> err()

parse(E::[string()]) -> {args(), flags()} | err()

parse(E::{tuple(), [string()]}) -> {tuple(), args(), flags()} | err()

parse_flags/1

parse_flags(Flags::[string()]) -> err() | flags()

validate/1

validate(E::err()) -> err()

validate(E::{tuple(), args(), flags(), flags()}) -> err() | {function(), [string()], proplist(), proplist(), flags()}

validate_flags/2

validate_flags(FlagSpecs::flagspecs(), Flags::flags()) -> err() | proplist()

Generated by EDoc