add docs
This commit is contained in:
1 parent
515d60f331
commit
3e26df844b
2 files changed
+4
-4
No files matched your search
+2
-2
@@ -286,8 +286,8 @@ defmodule FeedReader do
|
|||||||
@doc """
|
@doc """
|
||||||
Collects a caller-owned local XML file into a bounded parse result.
|
Collects a caller-owned local XML file into a bounded parse result.
|
||||||
|
|
||||||
The parser continues through the end of the source so malformed tails are
|
The parser stops after the feed's root element, ignoring content appended
|
||||||
reported. An item accepted beyond the limit returns
|
after a complete feed. An item accepted beyond the limit returns
|
||||||
`{:error, {:max_items_exceeded, max_items}}` without partial data.
|
`{:error, {:max_items_exceeded, max_items}}` without partial data.
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|||||||
@@ -5,8 +5,8 @@ defmodule FeedReader.Collector do
|
|||||||
The collector consumes the event stream produced by `FeedReader.Parser` and
|
The collector consumes the event stream produced by `FeedReader.Parser` and
|
||||||
returns a `FeedReader.ParseResult`. Callers must provide a positive integer
|
returns a `FeedReader.ParseResult`. Callers must provide a positive integer
|
||||||
`:max_items`; accepted items beyond that limit produce an error instead of a
|
`:max_items`; accepted items beyond that limit produce an error instead of a
|
||||||
partial result. The parser continues through its terminal event so malformed
|
partial result. The parser stops after the feed's root element, so content
|
||||||
tails are not hidden by the collection limit.
|
appended after a complete feed is not parsed.
|
||||||
|
|
||||||
Binary and chunk-enumerable inputs are written incrementally to a temporary
|
Binary and chunk-enumerable inputs are written incrementally to a temporary
|
||||||
file before parsing. The temporary file is owned and removed by the collector;
|
file before parsing. The temporary file is owned and removed by the collector;
|
||||||
|
|||||||
Reference in new issue
Block a user