# FeedReader v0.1.0 - Table of Contents

> FeedReader is an Elixir library for fetching and parsing RSS, Atom, and RDF feeds. It supports local files, binaries, streams, and remote URLs.

## Modules

- [FeedReader](FeedReader.md): Standalone feed fetching and parsing library.
- [FeedReader.Collector](FeedReader.Collector.md): Bounded collectors for local feed parsing.
- [FeedReader.Downloader](FeedReader.Downloader.md): Streams remote response bodies into owned temporary files while computing the
decoded MD5 checksum. Gzip and raw deflate are decoded incrementally; stacked
and unknown content encodings are rejected. See `download/2` for its options
and resource budgets.

- [FeedReader.Feed](FeedReader.Feed.md): Normalized metadata for a feed.
- [FeedReader.Fetch](FeedReader.Fetch.md): HTTP metadata for a completed remote feed fetch.
- [FeedReader.Format](FeedReader.Format.md): Behaviour implemented by built-in and explicitly supplied feed formats.
- [FeedReader.FormatDetector](FeedReader.FormatDetector.md): Internal bounded detection and replay for `FeedReader`.
- [FeedReader.FormatRegistry](FeedReader.FormatRegistry.md): Ordered registry of built-in formats.
- [FeedReader.Formats.Atom](FeedReader.Formats.Atom.md): Atom feed detection and normalization.
- [FeedReader.Formats.RDF](FeedReader.Formats.RDF.md): RDF Site Summary format detection and normalization.
- [FeedReader.Formats.RSS](FeedReader.Formats.RSS.md): RSS format detection and normalization.
- [FeedReader.Item](FeedReader.Item.md): A normalized item delivered by a feed parser.
- [FeedReader.ParseResult](FeedReader.ParseResult.md): A bounded collection of normalized data from a local source.
- [FeedReader.Parser](FeedReader.Parser.md): One-pass local feed parsing used by `FeedReader.stream_file/2`.
- [FeedReader.Recovery](FeedReader.Recovery.md): Public facade for streaming XML recovery.
- [FeedReader.Recovery.Attributes](FeedReader.Recovery.Attributes.md): Repairs malformed quotes in XML attributes.
- [FeedReader.Recovery.Encoding](FeedReader.Recovery.Encoding.md): Recovers character encoding mismatches in XML feeds.
- [FeedReader.Recovery.Entities](FeedReader.Recovery.Entities.md): Recovers entity and markup irregularities in streamed XML.
- [FeedReader.Recovery.Prefix](FeedReader.Recovery.Prefix.md): Recovers the beginning of an XML document before SAX parsing.
- [FeedReader.RemoteResult](FeedReader.RemoteResult.md): A bounded collection of normalized data and metadata from a remote fetch.
- [FeedReader.ReqTransport](FeedReader.ReqTransport.md): Req implementation of `FeedReader.Transport`.
- [FeedReader.Session](FeedReader.Session.md): A one-pass event stream over a feed.
- [FeedReader.Transport](FeedReader.Transport.md): Injectable HTTP transport boundary used by remote feed operations.
- [FeedReader.VerifiedParser](FeedReader.VerifiedParser.md): Validates a complete XML pass before returning a feed event session.
- [FeedReader.XMLResourceLimits](FeedReader.XMLResourceLimits.md): Accounts SAX events before a format handler retains their data.