posix-api: posix bindings
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
andAddr
are used pervasively. There is no use ofString
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
andSystem.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 involvesMonadIO
orMonadBaseControl
.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.
[Skip to Readme]
Modules
- Foreign
- C
- String
- Foreign.C.String.Managed
- String
- C
- Linux
- Linux.Epoll
- Linux.MessageQueue
- Linux.Socket
- Linux.Systemd
- Posix
- Posix.Directory
- Posix.File
- Posix.MessageQueue
- Posix.Poll
- Posix.Select
- Posix.Socket
- Struct
- AddressInfo
- Posix.Struct.AddressInfo.Peek
- SocketAddressInternet
- Posix.Struct.SocketAddressInternet.Peek
- AddressInfo
- Posix.Types
Flags
Manual Flags
Name | Description | Default |
---|---|---|
assertions | Extra run-time invariant checking | Disabled |
Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info
Downloads
- posix-api-0.4.0.1.tar.gz [browse] (Cabal source package)
- Package description (revised from the package)
Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
Versions [RSS] | 0.1.0.0, 0.2.0.0, 0.2.1.0, 0.3.0.0, 0.3.2.0, 0.3.3.0, 0.3.4.0, 0.3.5.0, 0.4.0.0, 0.4.0.1, 0.5.0.0, 0.6.0.0, 0.6.0.1, 0.6.1.0, 0.7.0.0, 0.7.1.0, 0.7.2.0 |
---|---|
Change log | CHANGELOG.md |
Dependencies | base (>=4.17.1 && <5), byte-order (>=0.1.2 && <0.2), byteslice (>=0.2.10 && <0.3), primitive (>=0.7 && <0.10), primitive-addr (>=0.1 && <0.2), primitive-offset (>=0.2 && <0.3), primitive-unlifted (>=2.0 && <2.2), run-st (>=0.1.1 && <0.2), text-short (>=0.1.5) [details] |
License | BSD-3-Clause |
Copyright | 2018 Andrew Martin |
Author | Andrew Martin |
Maintainer | andrew.thaddeus@gmail.com |
Revised | Revision 2 made by andrewthad at 2023-06-28T15:07:43Z |
Category | System |
Home page | https://github.com/andrewthad/posix-api |
Uploaded | by andrewthad at 2023-06-27T17:14:06Z |
Distributions | NixOS:0.7.2.0 |
Reverse Dependencies | 5 direct, 1 indirect [details] |
Downloads | 4025 total (43 in the last 30 days) |
Rating | (no votes yet) [estimated by Bayesian average] |
Your Rating | |
Status | Docs not available [build log] All reported builds failed as of 2023-08-25 [all 2 reports] |