Packages
fast_xml
1.1.46
1.1.60
1.1.59
1.1.58
1.1.57
1.1.56
1.1.55
1.1.53
1.1.52
1.1.51
1.1.49
1.1.48
1.1.47
1.1.46
1.1.45
1.1.43
1.1.41
1.1.40
1.1.39
1.1.38
1.1.37
1.1.36
1.1.35
1.1.34
1.1.32
1.1.31
1.1.30
1.1.29
1.1.28
1.1.27
1.1.26
1.1.24
1.1.23
1.1.22
1.1.20
1.1.19
1.1.18
1.1.15
1.1.14
1.1.13
1.1.12
1.1.11
1.1.10
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
Fast Expat-based Erlang / Elixir XML parsing library
Current section
Files
Jump to
Current section
Files
src/fxml_stream.erl
%%%----------------------------------------------------------------------
%%% File : fxml_stream.erl
%%% Author : Alexey Shchepin <alexey@process-one.net>
%%% Purpose : Parse XML streams
%%% Created : 17 Nov 2002 by Alexey Shchepin <alexey@process-one.net>
%%%
%%%
%%% Copyright (C) 2002-2021 ProcessOne, SARL. All Rights Reserved.
%%%
%%% Licensed under the Apache License, Version 2.0 (the "License");
%%% you may not use this file except in compliance with the License.
%%% You may obtain a copy of the License at
%%%
%%% http://www.apache.org/licenses/LICENSE-2.0
%%%
%%% Unless required by applicable law or agreed to in writing, software
%%% distributed under the License is distributed on an "AS IS" BASIS,
%%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%%% See the License for the specific language governing permissions and
%%% limitations under the License.
%%%
%%%----------------------------------------------------------------------
-module(fxml_stream).
-author('alexey@process-one.net').
-compile(no_native).
-export([new/1, new/2, new/3, parse/2, close/1, reset/1,
change_callback_pid/2, parse_element/1]).
-export([load_nif/0, load_nif/1]).
-include("fxml.hrl").
-record(xml_stream_state,
{callback_pid = self() :: pid(),
port :: port(),
stack = [] :: stack(),
size = 0 :: non_neg_integer(),
maxsize = infinity :: non_neg_integer() | infinity}).
-type xml_stream_el() :: {xmlstreamraw, binary()} |
{xmlstreamcdata, binary()} |
{xmlstreamelement, xmlel()} |
{xmlstreamend, binary()} |
{xmlstreamstart, binary(), [attr()]} |
{xmlstreamerror, binary()}.
-type xml_stream_state() :: #xml_stream_state{}.
-type stack() :: [xmlel()].
-export_type([xml_stream_state/0, xml_stream_el/0]).
load_nif() ->
SOPath = p1_nif_utils:get_so_path(?MODULE, [fast_xml], "fxml_stream"),
load_nif(SOPath).
load_nif(SOPath) ->
case erlang:load_nif(SOPath, 0) of
ok ->
ok;
{error, {Reason, Txt}} ->
error_logger:error_msg("failed to load NIF ~s: ~s",
[SOPath, Txt]),
{error, Reason}
end.
-spec new(pid()) -> xml_stream_state().
new(CallbackPid) ->
new(CallbackPid, infinity).
-spec new(pid(), non_neg_integer() | infinity) -> xml_stream_state().
new(_CallbackPid, _MaxSize) ->
erlang:nif_error(nif_not_loaded).
-spec new(pid(), non_neg_integer() | infinity, list()) -> xml_stream_state().
new(_CallbackPid, _MaxSize, _Options) ->
erlang:nif_error(nif_not_loaded).
-spec reset(xml_stream_state()) -> xml_stream_state().
reset(_State) ->
erlang:nif_error(nif_not_loaded).
-spec change_callback_pid(xml_stream_state(), pid()) -> xml_stream_state().
change_callback_pid(_State, _CallbackPid) ->
erlang:nif_error(nif_not_loaded).
-spec parse(xml_stream_state(), binary()) -> xml_stream_state().
parse(_State, _Data) ->
erlang:nif_error(nif_not_loaded).
-spec close(xml_stream_state()) -> true.
close(_State) ->
erlang:nif_error(nif_not_loaded).
-spec parse_element(binary()) -> xmlel() |
{error, atom()} |
{error, {integer(), binary()}}.
parse_element(_Str) ->
erlang:nif_error(nif_not_loaded).