unix-bytestring: Unix/Posix-specific functions for ByteStrings.

[ bsd3, library, system ] [ Propose Tags ]

Unix/Posix-specific functions for ByteStrings.

Provides ByteString file-descriptor based I/O API, designed loosely after the String file-descriptor based I/O API in System.Posix.IO. The functions here wrap standard C implementations of the functions specified by the ISO/IEC 9945-1:1990 (``POSIX.1'') and X/Open Portability Guide Issue 4, Version 2 (``XPG4.2'') specifications.

Note that this package doesn't require the unix package as a dependency. But you'll need it in order to get your hands on an Fd, so we're not offering a complete replacement.


[Skip to Readme]
Versions [RSS] [faq] 0.3.2, 0.3.2.1, 0.3.3, 0.3.4, 0.3.4.1, 0.3.5, 0.3.5.3, 0.3.5.4, 0.3.6, 0.3.7, 0.3.7.2, 0.3.7.3, 0.3.7.4, 0.3.7.5, 0.3.7.6
Change log CHANGELOG
Dependencies base (>=4.1 && <4.17), bytestring (>=0.9.1.5 && <0.12) [details]
License BSD-3-Clause
Copyright Copyright (c) 2010–2021 wren gayle romano
Author wren gayle romano
Maintainer wren@cpan.org
Category System
Home page https://wrengr.org/software/hackage.html
Bug tracker https://github.com/wrengr/unix-bytestring/issues
Source repo head: git clone https://github.com/wrengr/unix-bytestring.git
Uploaded by WrenRomano at 2021-11-03T04:16:13Z
Distributions Debian:0.3.5.4, LTSHaskell:0.3.7.6, NixOS:0.3.7.3, Stackage:0.3.7.6
Downloads 22782 total (929 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2021-11-03 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Candidates


Readme for unix-bytestring-0.3.7.6

[back to package description]

unix-bytestring

Hackage version Build Status Dependencies

Unix/Posix-specific functions for ByteStrings.

This package provides ByteString file-descriptor based I/O API, designed loosely after the String file-descriptor based I/O API in System.Posix.IO. The functions here wrap standard C implementations of the functions specified by the ISO/IEC 9945-1:1990 (“POSIX.1”) and X/Open Portability Guide Issue 4, Version 2 (“XPG4.2”) specifications.

Note that this package doesn't require the unix package as a dependency. But you'll need it in order to get your hands on an Fd, so we're not offering a complete replacement.

Install

In general, this is a simple package and should be easy to install. You must have hsc2hs installed in order to compile the package (but then you probably already do). With the cabal-install program you can just do the standard:

$> cabal install unix-bytestring

FFI Problems

The unix-bytestring package uses standard POSIX header files <sys/types.h>, <sys/uio.h>, and <unistd.h>. If Cabal has difficulty finding these files or reports another error, be sure your include path variables are correct. If the problem persists, contact the maintainer.

Building for GHC (6.8 and above)

Nothing special to mention.

Building for Hugs (September 2006)

I haven't actually compiled this for Hugs because I don't have a new enough version of Cabal for it, but I don't forsee any difficulties. If you do compile this for Hugs, let the maintainer know how it went.

When compiling for Hugs, see the following bugs for Cabal's interaction with ffihugs. These bugs do not currently affect this package, but this notice is here in case they affect future versions. For more details and a minimal regression suite, see:

<http://community.haskell.org/~wren/cabal-ffihugstest/>

(1) http://hackage.haskell.org/trac/hackage/ticket/526 Options in hugs-options aren't passed through to ffihugs, most importantly -98 and +o are the ones we'd like to pass. For enabling the +o flag Hugs-Sept06 does not honor: pragma {-# LANGUAGE OverlappingInstances #-} pragma {-# OPTIONS_HUGS +o #-} cabal extensions: OverlappingInstances And the -98 flag has similar issues. Therefore this is a real problem.

Immediate solution: The options set in hugs-options should be passed to ffihugs as well. As of Cabal 1.6 they are not passed (verified by Duncan Coutts). The two programs accept all the same options, so this is valid.

Ideal solution: Based on the extensions field, Cabal should automatically determine whether -98 and +o need to be enabled (for both hugs and ffihugs).

(2) http://hackage.haskell.org/trac/hackage/ticket/527 If CPP is being used in conjunction with FFI, then cpp/cpphs is not called before ffihugs is called. Thus, users must pass an -F flag to ffihugs in order to declare a code filter (and must pass all cpp-options to -F manually). For example:

--ffihugs-option=-F'cpp -P -traditional -D__HUGS__ -D__BLAH__'

This requires duplicating the build specifications, which defeats the point of Cabal. Also it leads to tricky issues about ensuring the proper level of quoting/escaping. (e.g. using the plural, --ffihugs-options=..., breaks it. Wrapping the -F'cpp...' in double quotes breaks it.)