aboutsummaryrefslogtreecommitdiffhomepage
path: root/pipes-text.cabal
diff options
context:
space:
mode:
Diffstat (limited to 'pipes-text.cabal')
-rw-r--r--pipes-text.cabal24
1 files changed, 8 insertions, 16 deletions
diff --git a/pipes-text.cabal b/pipes-text.cabal
index be43397..a6c2971 100644
--- a/pipes-text.cabal
+++ b/pipes-text.cabal
@@ -1,25 +1,17 @@
1name: pipes-text 1name: pipes-text
2version: 0.0.0.7 2version: 0.0.0.7
3synopsis: Text pipes. 3synopsis: Text pipes.
4description: Many of the pipes and other operations defined here mirror those in 4description: (This package will be in a draft, or testing, phase until version 0.0.1. Please report any api objections or installation difficulties on the github page!)
5 the `pipes-bytestring` library. Folds like `length` and grouping 5
6 operations like `lines` simply adjust for the differences between 6 This organization of the package follows the rule
7 `ByteString` and `Text` and `Word8` and `Char`. It is hoped that this 7 .
8 homogeneity will aid in learning the terms and programming style associated 8 * @pipes-text : pipes-bytestring :: text : bytestring@
9 with both of them.
10 . 9 .
11 The most distinctive addition of the library to that core is the 10 Familiarity with the other three packages should give one an idea what to expect where. The package has three modules, @Pipes.Text@ , @Pipes.Text.Encoding@ and @Pipes.Text.IO@; the division has more or less the significance it has in the @text@ library.
12 apparatus for encoding and decoding `Text` and `ByteString`.
13 . 11 .
14 Also defined are some simple functions akin to the `String` 12 Note that the module @Pipes.Text.IO@ is present as a convenience (as is @Data.Text.IO@). Official pipes IO would use @Pipes.ByteString@ and the decoding functions present here, based on the new Michael Snoyman's new @text-stream-decoding@ package. In particular, the @Pipes.Text.IO@ functions use Text exceptions.
15 operations in `Pipes.Prelude`, and others like the utilities in `Data.Text`.
16 . 13 .
17 All of the `IO` operations defined here - e.g `readFile`, `stdout` etc. 14 @Pipes.Text.IO@ uses version 0.11.3 or later of the @text@ library. It thus works with the version of @text@ that came with the 2013 Haskell Platform. To use an older @text@, install with the flag @-fnoio@
18 - are conveniences akin to those in `Data.Text.IO` which e.g. try to
19 find the system encoding and use the exceptions defined in the `text`
20 library. Proper `IO` in the sense of this library will employ
21 `pipes-bytestring` in conjuntion with 'pure' operations like
22 `decodeUtf8` and `encodeUtf8` that are defined here.
23 15
24homepage: https://github.com/michaelt/text-pipes 16homepage: https://github.com/michaelt/text-pipes
25bug-reports: https://github.com/michaelt/text-pipes/issues 17bug-reports: https://github.com/michaelt/text-pipes/issues