diff options
Diffstat (limited to 'pipes-text.cabal')
| -rw-r--r-- | pipes-text.cabal | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/pipes-text.cabal b/pipes-text.cabal index ef563c7..07659ae 100644 --- a/pipes-text.cabal +++ b/pipes-text.cabal | |||
| @@ -1,17 +1,21 @@ | |||
| 1 | name: pipes-text | 1 | name: pipes-text |
| 2 | version: 0.0.2.2 | 2 | version: 0.0.2.3 |
| 3 | synopsis: properly streaming text | 3 | synopsis: properly streaming text |
| 4 | description: New in version 0.0.2/: A new module @Pipes.Prelude.Text@ exports line-based @Text@ producers and consumers as a drop-in replacement for the @String@ material in @Pipes.Prelude@ and @Pipes.Safe.Prelude@. They can be used as one uses @Pipes.Prelude@ without reference to the rest of this package. See the caveats in the documentation for that module. | 4 | description: /New in version 0.0.2.x/: The new module @Pipes.Prelude.Text@ exports line-based @Text@ producers and consumers as a drop-in replacement for the @String@ material in @Pipes.Prelude@ and @Pipes.Safe.Prelude@. They can be used as one uses @Pipes.Prelude@ without reference to the rest of this package. See the caveats in the documentation for that module. |
| 5 | . | 5 | . |
| 6 | The organization of this package follows the rule: | 6 | The organization of this package follows the rule: |
| 7 | . | 7 | . |
| 8 | * @pipes-text : pipes-bytestring :: text : bytestring@ | 8 | * @pipes-text : pipes-bytestring :: text : bytestring@ |
| 9 | . | 9 | . |
| 10 | Familiarity with the other three packages should give one an idea what to expect where. The package has three principal modules, @Pipes.Text@ , @Pipes.Text.Encoding@ and @Pipes.Text.IO@; the division has more or less the significance it has in the @text@ library. A fourth module @Pipes.Prelude.Text@ is explained below. | 10 | Familiarity with the other three packages should give one an idea what to expect where. The package has three principal modules, @Pipes.Text@ , @Pipes.Text.Encoding@ and @Pipes.Text.IO@; the division has more or less the significance it has in the @text@ library. |
| 11 | . | 11 | . |
| 12 | The module @Pipes.Text.IO@ is present as a convenience. Official pipes IO would use @Pipes.ByteString@ together with the bytestring decoding functions in @Pipes.Text.Encoding@. In particular, the @Pipes.Text.IO@ functions use Text exceptions. | 12 | The module @Pipes.Text.IO@ is present as a convenience. Official pipes IO uses @Pipes.ByteString@ together with the bytestring decoding functions in @Pipes.Text.Encoding@. In particular, the @Pipes.Text.IO@ functions use Text exceptions, while @Pipes.Text@ uses the standard pipes practice of breaking with a failed parse. Thus, for example, the type of @decodeUtf8@ is |
| 13 | . | 13 | . |
| 14 | @Pipes.Text.IO@ and @Pipes.Prelude.Text@ use version 0.11.3 or later of the @text@ library. To use a (very) old version of @text@, install with the flag @-fnoio@ | 14 | * @decodeUtf8 :: Monad m => Producer ByteString m r -> Producer Text m (Producer ByteString m r)@ |
| 15 | . | ||
| 16 | where any unparsed bytes are returned. | ||
| 17 | . | ||
| 18 | @Pipes.Text.IO@ and @Pipes.Prelude.Text@ use version 0.11.3 or later of the @text@ library; older versions of @text@ can be used with the flag @-fnoio@ | ||
| 15 | 19 | ||
| 16 | 20 | ||
| 17 | 21 | ||