View Source ndto_parser behaviour (ndto v0.3.1)

An ndto interface and behaviour for schema parsers.

Summary

Types

ctx/0
spec/0
t/0
A parser is a module that implements the ndto_parser behaviour.

Callbacks

parse/2
Parses a specification into a list of ndto:schema() values.

Functions

parse(Parser, SpecPath)

Equivalent to parse(Parser, SpecPath, #{}).

parse(Parser, SpecPath, Opts)
Parses a schema specification into a ndto:schema() using the given parser.

Types

Link to this type

ctx/0

View Source 
-type ctx() :: term().
Link to this type

spec/0

View Source 
-type spec() :: term().
Link to this opaque

t/0

View Source 
-opaque t()
A parser is a module that implements the ndto_parser behaviour.

Callbacks

Link to this callback

parse/2

View Source 
-callback parse(SpecPath, Opts) -> Result
         when
             SpecPath :: file:filename_all(),
             Opts :: map(),
             Result :: {ok, Schemas} | {error, Reason},
             Schemas :: [{ndto:name(), ndto:schema()}],
             Reason :: term().
Parses a specification into a list of ndto:schema() values.

Functions

Link to this function

parse(Parser, SpecPath)

View Source 
-spec parse(Parser, SpecPath) -> Result
         when
             Parser :: t(),
             SpecPath :: file:filename_all(),
             Result :: {ok, Schemas} | {error, Reason},
             Schemas :: [{ndto:name(), ndto:schema()}],
             Reason :: term().

Equivalent to parse(Parser, SpecPath, #{}).

Link to this function

parse(Parser, SpecPath, Opts)

View Source 
-spec parse(Parser, SpecPath, Opts) -> Result
         when
             Parser :: t(),
             SpecPath :: file:filename_all(),
             Opts :: map(),
             Result :: {ok, Schemas} | {error, Reason},
             Schemas :: [{ndto:name(), ndto:schema()}],
             Reason :: term().
Parses a schema specification into a ndto:schema() using the given parser.