The rawfilepath package

[Tags:apache, library, test]

Please see README.md


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.1, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 0.2.4
Dependencies base (>=4.7 && <5), bytestring, unix [details]
License Apache-2.0
Copyright 2016 XT
Author XT
Maintainer e@xtendo.org
Category System
Home page https://github.com/xtendo-org/rawfilepath#readme
Source repository head: git clone https://github.com/xtendo-org/rawfilepath
Uploaded Thu May 11 07:06:47 UTC 2017 by XT
Distributions LTSHaskell:0.1.1, NixOS:0.2.4, Stackage:0.2.4, Tumbleweed:0.1.1
Downloads 290 total (27 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Last success reported on 2017-05-11 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for rawfilepath

Readme for rawfilepath-0.2.4

rawfilepath

A Haskell library for the mid-level system functions for the RawFilePath data type.

Background

Traditional String is notorious:

  • 24 bytes (three words) required for one character (the List constructor, the actual Char value, and the pointer to the next List constructor). 24x memory consumption.
  • Heap fragmentation causing malloc/free overhead
  • A lot of pointer chasing for reading, devastating the cache hit rate
  • A lot of pointer chasing plus a lot of heap object allocation for manipulation (appending, slicing, etc.)
  • Completely unnecessary but mandatory conversions and memory allocation when the data is sent to or received from the outside world

Transition to Text and ByteString began, but even after a dazzling community effort, FilePath, a key data type for programming anything useful, remained to be a type synonym of String.

To put a cherry on top of creaking, fuming, dragging, and littering pointers all over the heap space, String had another fantastic nature to serve as a file path data type: Encoding blindness. All functions that return FilePath would actually take a series of bytes returned by a syscall and somehow magically "decode" it into a String which is surprising because no encoding information was given. Of course there is no magic and it's an abject fail. FilePath just wouldn't work.

In June 2015, three bright Haskell programmers came up with an elegant solution called the Abstract FilePath Proposal and met an immediate thunderous applause. Inspired by this enthusiasm, they further pursued the career of professional Haskell programming and focused on more interesting things. 16 months later, a programmer under the pseudonym XT got so sick and tired of the situation and released a package called rawfilepath that, despite being far from perfect, worked.

So what is this?

RawFilePath is a data type provided by the unix package. It has no performance issues because it is ByteString which is packed. It has no encoding issues because it is ByteString which is a sequence of bytes instead of characters. However, the functions in unix are low-level, and the higher-level packages such as process and directory are strictly tied to FilePath.

So I decided to start writing the RawFilePath version of those functions.

Advantages

  • High performance
  • No round-trip encoding issue
  • Minimal dependencies (bytestring, unix, and base)
  • Lightweight library (under 400 total lines of code)
  • Available now

Documentation

API documentation of rawfilepath on Stackage.

To do

rawfilepath is in an early stage, although major backwards-incompatible changes are unlikely to happen. We can probably port more system functions that are present in process or directory

Patches will be highly appreciated.