FeedReader.FormatDetector (FeedReader v0.1.0)

Internal bounded detection and replay for FeedReader.

Summary

Returns the detected format id, or :unknown, from a bounded prefix.

Returns the detected id, inspected prefix, and replayable input stream.

Checks whether the bounded prefix matches the explicitly selected format.

@spec detect(binary(), keyword()) :: FeedReader.format_id()

Returns the detected format id, or :unknown, from a bounded prefix.

@spec detect_and_replay(binary() | Enumerable.t(), keyword()) ::
  {FeedReader.format_id(), binary(), Enumerable.t()}

Returns the detected id, inspected prefix, and replayable input stream.

@spec validate(binary(), atom() | module(), keyword()) :: boolean()

Checks whether the bounded prefix matches the explicitly selected format.