View Source exml_stream (exml v3.4.1)
Summary
Functions
Free a parser
See also: new_parser/1.
Creates a new parser
Makes a parser parse input
Resets the parser's buffers
Types
-type element() :: exml_nif:stream_element().
start/0
, stop/0
or exml:element()
.
-type parser() :: #parser{}.
#parser{}
record.
-type parser_opt() :: {infinite_stream, boolean()} | {max_element_size, non_neg_integer()}.
Parser options
-type start() :: #xmlstreamstart{}.
#xmlstreamstart{}
record.
-type stop() :: #xmlstreamend{}.
#xmlstreamend{}
record.
Functions
-spec free_parser(parser()) -> ok.
Free a parser
Kept for backwards-compatibility, it is a no-op.-spec new_parser() -> {ok, parser()} | {error, any()}.
See also: new_parser/1.
-spec new_parser([parser_opt()]) -> {ok, parser()} | {error, any()}.
-spec parse(parser(), binary()) -> {ok, parser(), [exml_stream:element()]} | {error, Reason :: any()}.