File: README.md

package info (click to toggle)
haskell-process-conduit 1.1.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 104 kB
  • sloc: haskell: 134; makefile: 2
file content (76 lines) | stat: -rw-r--r-- 1,538 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
process-conduit: Conduit for processes
======================================

# About

This package provides [conduit](http://hackage.haskell.org/package/conduit)
for processes.
Also this provides quasi-quoters for process using it.

# Install

~~~ {.bash}
$ cabal update
$ cabal install process-conduit
~~~

# Document

Haddock documents are here:

<http://hackage.haskell.org/package/process-conduit>

# Quasi Quoters

process-conduit has three quasi-quoters, `cmd`, `scmd` and `ccmd`.

The result type of `cmd` is Lazy `ByteString`,
but execution will perform strictly.

The result type of `scmd` and `ccmd` are
`GSource m ByteString` and
`GConduit ByteString m ByteString` respectively.

If a command is failed, an exception is thrown.

Commands are executed in ***run-time***, not compile-time.

# Examples

* Create a Source and a Conduit of process

~~~ {.haskell}
import Data.Conduit
import qualified Data.Conduit.Binary as CB
import Data.Conduit.Process
import System.IO

main :: IO ()
main = runResourceT $ do
  sourceCmd "ls" $= conduitCmd "sort" $$ CB.sinkHandle stdout
~~~

* Invoke a process simply

~~~ {.haskell}
{-# LANGUAGE QuasiQuotes #-}
import System.Process.QQ

main = print =<< [cmd|ls|]
~~~

* Conduit Quasi-Quoters

~~~ {.haskell}
main :: IO ()
main = runResourceT $ do
  [scmd|ls|] $= [ccmd|sort|] $$ CB.sinkHandle stdout
~~~

* Unquoting (syntax is same as [shakespeare-text](http://hackage.haskell.org/package/shakespeare-text))

~~~ {.haskell}
main = do
  [url] <- getArgs
  print =<< [cmd|curl #{url}|]
~~~