Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

accessing user_state inside partial to allow streaming output #100

Merged
merged 4 commits into from
May 16, 2022
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions lib/saxy/partial.ex
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,36 @@ defmodule Saxy.Partial do
end
end

@doc """
Same as partial/2, but continue previous parsing with a new, provided state
as the third argument instead of the previous accumulated state.

i.e.
`Saxy.Partial.parse(partial, binary, new_state) # coninue previous partial with a new state`

This function can return in 3 ways:

* `{:cont, partial}` - The parsing process has not been terminated.
* `{:halt, user_state}` - The parsing process has been terminated, usually because of parser stopping.
* `{:halt, user_state, rest}` - The parsing process has been terminated, usually because of parser halting.
* `{:error, exception}` - The parsing process has erred.

"""
@spec parse(
partial :: t(),
data :: binary,
user_state :: map()
qcam marked this conversation as resolved.
Show resolved Hide resolved
) ::
{:cont, partial :: t()}
| {:halt, state :: term()}
| {:halt, state :: term(), rest :: binary()}
| {:error, exception :: Saxy.ParseError.t()}

def parse(%__MODULE__{} = partial, data, user_state) do
partial = set_user_state(partial, user_state)
parse(partial, data)
end

@doc """
Terminates the XML document parsing.
"""
Expand All @@ -109,4 +139,14 @@ defmodule Saxy.Partial do
{:ok, state.user_state}
end
end

@doc """
Obtain the state set by the user.
"""
@spec get_state(partial :: t()) :: state :: term()
def get_state(%__MODULE__{state: %{user_state: user_state}}), do: user_state

@spec set_user_state(partial :: t(), user_state :: term()) :: partial :: t()
defp set_user_state(%__MODULE__{state: state} = partial, user_state),
do: %{partial | state: %{state | user_state: user_state}}
end