network-attoparsec 0.12.1 → 0.12.2

raw patch · 2 files changed

+8/−1 lines, 2 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• network-attoparsec.cabal +1/−1
• src/Network/Attoparsec.hs +7/−0

@@ -1,6 +1,6 @@ name: network-attoparsec
 category: Network, Parsing
-version: 0.12.1
+version: 0.12.2
 license: MIT
 license-file: LICENSE
 copyright: (c) 2015 Leon Mergen

@@ -11,6 +11,13 @@ 
 Utility functions for running a parser against a socket, without the need of a
 bigger framework such as Pipes or Conduit.
+
+__WARNING__: In certain situations while using the attoparsec string parser, it
+             is possible that a network parser ends in a forever-blocking state,
+             expecting more input. This is a side effect of the way attoparsec
+             is written. I have written a thorough explanation on this issue, and
+             <http://www.leonmergen.com/haskell/attoparsec/2015/03/15/on-writing-non-blocking-parsers-for-attoparsec.html how to avoid attoparsec returning a partial result> when a different branch should be evaluated.
+
 -}
 
 module Network.Attoparsec (ParseC, parseMany, parseOne) where