Data.CStringRepresentable

This module provides the type class (and a few implementations) for values that can be efficiently converted to/from CString. Instances for String and strict ByteString are provided, and the use of ByteString is recommended if performance is a concern.

Documentation

class CStringRepresentable a where

Represents values that can be efficiently converted to and from CStrings.

Minimal complete definition

toCString, fromCString

Methods

toCString :: a -> (CString -> IO b) -> IO b

Perform a function on the CString representation of the value.

fromCString :: CString -> IO a

Convert CString to a value of the type. The ownership is not transferred.

Instances

CStringRepresentable String

Strings can be represented as CStrings (albeit conversions are inefficient).

Methods

toCString :: String -> (CString -> IO b) -> IO b

fromCString :: CString -> IO String

CStringRepresentable ByteString

ByteStrings can be represented as CStrings.

Methods

toCString :: ByteString -> (CString -> IO b) -> IO b

fromCString :: CString -> IO ByteString