vow v0.0.1 Vow View Source

TODO

Link to this section Summary

Types

fspec_opt()

fspec_opts()

key_opt()

key_opts()

list_opt()

list_opts()

map_opt()

map_opts()

merged()

spec_ref()

spec_ref_expr()

t()

Functions

also(specs)

also(spec1, spec2)

alt(named_specs)

amp(specs)

amp(spec1, spec2)

any?(term)

cat(named_specs)

conform(spec, value)

conform!(spec, value)

conform_function(spec, function, args \\ [])

See Vow.Function.conform/3.

explain(spec, value)

fspec(opts)

invalid?(spec, value)

keys(opts)

keyword_of(spec, opts \\ [])

list_of(spec, opts \\ [])

map_of(key_spec, value_spec, opts \\ [])

maybe(spec)

merge(specs, merge_fun \\ nil)

nilable(spec)

one_of(named_specs)

one_or_more(spec)

oom(spec)

regex?(spec)

set(enumerable)

term?(term)

valid?(spec, value)

zero_or_more(spec)

zom(spec)

Link to this section Types

fspec_opt()

fspec_opt() :: {:args, [t()]} | {:ret, t()} | {:fun, t()}

fspec_opts()

fspec_opts() :: [fspec_opt()]

key_opt()

key_opt() ::
  {:required, [spec_ref_expr()]}
  | {:optional, [spec_ref_expr()]}
  | {:into, [] | %{}}

key_opts()

key_opts() :: [key_opt()]

list_opt()

list_opt() ::
  {:length, Range.t() | non_neg_integer()}
  | {:min_length, non_neg_integer()}
  | {:max_length, non_neg_integer()}
  | {:distinct?, boolean()}

list_opts()

list_opts() :: [list_opt()]

map_opt()

map_opt() :: list_opt() | {:conform_keys?, boolean()}

map_opts()

map_opts() :: [map_opt()]

merged()

merged() ::
  Vow.Merge.t()
  | Vow.Map.t()
  | Vow.Keys.t()
  | map()
  | Vow.Alt.t()
  | Vow.OneOf.t()
  | Vow.Cat.t()

spec_ref()

spec_ref() :: atom() | {module(), atom()} | Vow.Ref.t()

spec_ref_expr()

spec_ref_expr() :: spec_ref() | {:and | :or, [spec_ref_expr(), ...]}

t()

t() :: Vow.Conformable.t()

Link to this section Functions

also(specs)

also([t()]) :: t()

also(spec1, spec2)

also(t(), t()) :: t()

alt(named_specs)

alt([{atom(), t()}, ...]) :: t() | no_return()

amp(specs)

amp([t()]) :: t()

amp(spec1, spec2)

amp(t(), t()) :: t()

any?(term)

any?(term()) :: boolean()

cat(named_specs)

cat([{atom(), t()}, ...]) :: t() | no_return()

conform(spec, value)

conform(t(), value :: term()) ::
  {:ok, Vow.Conformable.conformed()} | {:error, Vow.ConformError.t()}

conform!(spec, value)

conform!(t(), value :: term()) :: Vow.Conformable.conformed() | no_return()

conform_function(spec, function, args \\ [])

See Vow.Function.conform/3.

explain(spec, value)

explain(t(), value :: term()) :: Vow.ConformError.t() | nil

fspec(opts)

fspec(fspec_opts()) :: t()

invalid?(spec, value)

invalid?(t(), value :: term()) :: boolean()

keys(opts)

keys(key_opts()) :: t() | no_return()

keyword_of(spec, opts \\ [])

keyword_of(t(), list_opts()) :: t()

list_of(spec, opts \\ [])

list_of(t(), list_opts()) :: t()

map_of(key_spec, value_spec, opts \\ [])

map_of(key_spec :: t(), value_spec :: t(), map_opts()) :: t()

maybe(spec)

maybe(t()) :: t()

merge(specs, merge_fun \\ nil)

merge([merged()], (key, value, value -> value) | nil) :: t()
when key: term(), value: term()

nilable(spec)

nilable(t()) :: t()

one_of(named_specs)

one_of([{atom(), t()}, ...]) :: t() | no_return()

one_or_more(spec)

one_or_more(t()) :: t()

oom(spec)

oom(t()) :: t()

regex?(spec)

regex?(t()) :: boolean()

set(enumerable)

set(Enum.t()) :: MapSet.t()

term?(term)

term?(term()) :: boolean()

valid?(spec, value)

valid?(t(), value :: term()) :: boolean()

zero_or_more(spec)

zero_or_more(t()) :: t()

zom(spec)

zom(t()) :: t()