redneb / disk-free-space Goto Github PK

I am moving my program to using RawFilePath (ByteString), but before using this library I have to convert back to FilePath. That is somewhat slow and complicated. It would be great to have a System.DiskSpace.ByteString (following the namespace that the unix package uses for RawFilePath modules).

Implementation should be simple, System.Posix.ByteString.FilePath.withFilePath produces a CString, and getDiskUsage just needs to have the part that uses CString split out to a helper function.

RawFilePath does not make sense on Windows, so the System.DiskSpace.ByteString module could be only made available on unix.

If this is an acceptable plan, I'll implement it.

I was using an old ghc 7.4.1 which released with Debian Wheezy. I wasn't able to depend on this package as is, because its minimum requirement in the cabal file for base is 4.6.

The package built fine for me when I lowered the requirement to 4.5, and I wonder if you might upload a version with the lowered requirement?

This is a useful package, thanks! I'm using it on both Windows and Linux very happily.

Would be even more useful if it was included in Stackage - https://github.com/fpco/stackage#get-your-package-included.

The import of statvfs is:

foreign import ccall unsafe statvfs :: CString -> Ptr a -> IO CInt

Since this function is doing a system call, I'm not sure why it is marked as unsafe - in case of remote filesystems, this could block for a long time (in real world terms). What do you think about making this safe, since the overhead of the syscall will anyway make the Haskell RTS overhead most likely moot?

It would be good to mention just which OS's this is known to work on. The need for 64 bit values for modern disk sizes may be a complication for some OS's too, so it's probably worth a mention.

I've been maintaining similar portable code in git-annex, so I compared the two.

The OS's I'm confident disk-free-space works on, after testing: Linux, OSX, Windows, Debian kFreeBSD. Probably regular FreeBSD, but I don't know for sure. OpenBSD: Don't know.