posix-api
Version 0.7.1.0 revision 0 uploaded by andrewthad.
Package meta
- Synopsis
- posix bindings
- Description
This library provides a very thin wrapper around POSIX APIs. It can be compiled on any operating system that implements the standard as specified in IEEE Std 1003.1 faithfully. It has similar goals as the unix package, but its design differs in several areas:
ByteArray and Addr are used pervasively. There is no use of String in this library.
Functions do not throw errors. This library uses `IO (Either Errno a)` in places where unix would use `IO a`.
The numeric types from Foreign.C.Types and System.Posix.Types are used in the type signatures of functions so that a haskell function's type signature matches its underlying POSIX equivalent exactly.
Flags are newtypes over CInt (or whatever integral type matches the posix specification) rather than enumerations. The data constructors are exported, making the types extensible for operating system that have additional flags.
About a dozen other packages offers wrappers for some subset of the POSIX specification are strewn across hackage. They include `regex-posix`, `posix-paths`, `posix-timer`, `posix-socket`, `posix-filelock`, `posix-acl`, etc. This library differs from all off these in various ways. Here are some of the design guidelines followed here that distinguish this package from some or all of these others:
Scope. Although this library does not include all APIs specified by POSIX, it welcomes as many of them as anyone is willing to implement.
Monomorphization. Effectful functions in this library return their results in IO rather than using a type that involves MonadIO or MonadBaseControl.
Typeclass avoidance. This library does not introduce new typeclasses. Overloading is eschewed in favor of providing multiple functions with distinct names.
Minimality. Functions wrapping the POSIX APIs do little more than wrap the underlying functions. The major deviation here is that, when applicable, the wrappers allocate buffers are the underlying functions fill. This eschews C's characteristic buffer-passing in favor of the Haskell convention of allocating internally and returning. A more minor deviation is that for safe FFI calls, this library will perform additional work to ensure that only pinned byte arrays are handed over.
Unlike network, this sockets API in this library does not integrate sockets with GHC's event manager. This is geared toward an audience that understands how to use threadWaitRead and threadWaitWrite with unsafe FFI calls to avoid blocking the runtime.
- Author
- Andrew Martin
- Bug reports
- n/a
- Category
- System
- Copyright
- 2018 Andrew Martin
- Homepage
- https://github.com/andrewthad/posix-api
- Maintainer
- andrew.thaddeus@gmail.com
- Package URL
- n/a
- Stability
- n/a