The safer-file-handles package

[Tags:bsd3, library]

This package adds three safety features on top of the regular System.IO file handles and operations:

The primary technique used in this package is called "Lightweight monadic regions" which was invented by Oleg Kiselyov and Chung-chieh Shan. See:

http://okmij.org/ftp/Haskell/regions.html#light-weight

This technique is implemented in the regions package which is re-exported from safer-file-handles.

See the safer-file-handles-examples package for examples how to use this package:

git clone https://github.com/basvandijk/safer-file-handles-examples

See the safer-file-handles-bytestring/text package for ByteString/Text operations on regional file handles.


[Skip to Readme]

Properties

Versions 0.1, 0.2, 0.2.0.1, 0.3, 0.3.0.1, 0.4, 0.5, 0.6, 0.6.1, 0.7, 0.8, 0.9, 0.10, 0.10.0.1, 0.11
Change log NEWS
Dependencies base (>=4 && <4.5), base-unicode-symbols (>=0.1.1 && <0.3), explicit-iomodes (>=0.5 && <0.7), pathtype (>=0.0.1 && <0.6), regional-pointers (==0.7.*), regions (==0.11.*), transformers (==0.2.*) [details]
License BSD3
Copyright 2010-2011 Bas van Dijk
Author Bas van Dijk
Maintainer Bas van Dijk <v.dijk.bas@gmail.com>
Stability experimental
Category System, Monadic Regions
Home page https://github.com/basvandijk/safer-file-handles/
Bug tracker https://github.com/basvandijk/safer-file-handles/issues
Source repository head: git clone git://github.com/basvandijk/safer-file-handles.git
Uploaded Fri Sep 23 10:10:47 UTC 2011 by BasVanDijk
Distributions NixOS:0.11
Downloads 2681 total (26 in the last 30 days)
Votes
0 []
Status Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for safer-file-handles

Readme for safer-file-handles-0.11

This package adds three safety features on top of the regular System.IO file handles and operations:

  • Regional file handles. Files must be opened in a region. When the region terminates all opened files are automatically closed. The main advantage of regions is that the handles to the opened files can not be returned from the region which ensures no I/O with closed files is possible.

  • Explicit IOModes. The regional file handles are parameterized by the IOMode in which they were opened. All operations on handles explicitly specify the needed IOMode. This way it is impossible to read from a write-only handle or write to a read-only handle for example.

  • Type-safe filepath creation and manipulation using the pathtype package.

The primary technique used in this package is called "Lightweight monadic regions" which was invented by Oleg Kiselyov and Chung-chieh Shan.

This technique is implemented in the regions package which is re-exported from safer-file-handles.

See the safer-file-handles-examples package for examples how to use this package:

git clone git://github.com/basvandijk/safer-file-handles-examples.git

See the safer-file-handles-bytestring and safer-file-handles-text packages for ByteString / Text operations on regional file handles.