Z-IO: Simple and high performance IO toolkit for Haskell

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Simple and high performance IO toolkit for Haskell, including file system, network, ipc and more!

[Skip to Readme]

Properties

Versions	0.1.0.0, 0.1.1.0, 0.1.1.1, 0.1.1.2, 0.1.2.0, 0.1.3.0, 0.1.4.0, 0.1.5.0, 0.1.5.1, 0.1.5.2, 0.1.6.0, 0.1.6.1, 0.1.7.0, 0.1.8.0, 0.1.8.1, 0.1.9.0, 0.2.0.0, 0.3.0.0, 0.4.0.0, 0.5.0.0, 0.6.0.0, 0.6.1.0, 0.6.1.0, 0.6.2.0, 0.6.3.0, 0.6.4.0, 0.7.0.0, 0.7.1.0, 0.8.0.0, 0.8.1.0, 0.8.1.1, 1.0.0.0, 1.0.1.0, 1.0.2.0, 2.0.0.0
Change log	ChangeLog.md
Dependencies	base (>=4.12 && <5.0), containers (>=0.6 && <0.7), exceptions (>=0.10 && <0.11), primitive (>=0.7.1 && <0.7.2), stm (>=2.5 && <2.6), time (>=1.9 && <=2.0), unix-time (>=0.4.7 && <=0.5), unordered-containers (>=0.2 && <0.3), Z-Data (>=0.6 && <0.7) [details]
License	BSD-3-Clause
Copyright	(c) Z.Haskell Contributors
Author	Z.Haskell Contributors
Maintainer	winterland1989@gmail.com
Category	Data
Home page	https://github.com/ZHaskell/Z-IO
Bug tracker	https://github.com/ZHaskell/Z-IO/issues
Source repo	head: git clone git://github.com/ZHaskell/Z-IO.git
Uploaded	by winterland at 2021-02-09T11:42:13Z

Modules

[Index] [Quick Jump]

Flags

Manual Flags

Name	Description	Default
no-pkg-config	Don't use pkg-config to check for library dependences(on platforms other than linux, win and osx)	Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Z-IO-0.6.1.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

winterland, lyndward

For package maintainers and hackage trustees

edit package information

Readme for Z-IO-0.6.1.0

[back to package description]

Z-IO

This package is part of Z.Haskell project, provides basic IO operations:

IO resource management, resource pool
File system operations
Network: DNS, TCP, UDP and IPC
Buffered input and output
Process management
Environment settings
High performance logger
High performance low resolution timer

Requirements

A working haskell compiler system, GHC(>=8.6), cabal-install(>=2.4), hsc2hs.
Tests need hspec-discover.

Example usage

> :set -XOverloadedStrings
> import Z.IO.Network
> import Z.IO.Resource
> import Z.IO.Buffered
>
> -- call getAddrInfo to perform DNS
> head <$> getAddrInfo Nothing "www.bing.com" "http"
AddrInfo {addrFlags = [AI_ADDRCONFIG,AI_V4MAPPED], addrFamily = SocketFamily 2, addrSocketType = SocketType 1, addrProtocol = ProtocolNumber 6, addrAddress = 204.79.197.200:80, addrCanonName = }
>
> import qualified Z.Data.Text as T
> -- send a simple HTTP request
> :{
let addr = ipv4 "13.107.21.200" 80
in withResource (initTCPClient defaultTCPClientConfig{ tcpRemoteAddr = addr}) $ \ tcp -> do
    i <- newBufferedInput tcp
    o <- newBufferedOutput tcp
    writeBuffer o "GET http://www.bing.com HTTP/1.1\r\nHost: www.bing.com\r\n\r\n"
    flushBuffer o
    readBuffer i >>= pure . T.validate
:}
"HTTP/1.1 200 OK\r\nDate: Sat, 19 Sep 2020 06:11:08 GMT\r\nContent-Length: 0\r\n\r\n"
>
> -- Start a TCP echo server, use @nc -v localhost 8080@ to test
> :{
startTCPServer defaultTCPServerConfig{
    tcpListenAddr = SocketAddrIPv4 ipv4Loopback 8080} $ \ tcp -> do
        i <- newBufferedInput tcp
        o <- newBufferedOutput tcp
        forever $ readBuffer i >>= writeBuffer o >> flushBuffer o
}
:}

Dev guide

# get code
git clone --recursive git@github.com:ZHaskell/z-io.git
cd z-io
# build
cabal build
# test
cabal run Z-IO-Test
# install
cabal install
# generate document
cabal haddock