Util.ICStringLen

This module provides immutable CStrings, which additionally have the property that they are automatically freed when the garbage-collector forgets about them.

Documentation

data ICStringLen

Instances

Eq ICStringLen

Defined in Util.ICStringLen

Methods

(==) :: ICStringLen -> ICStringLen -> Bool

(/=) :: ICStringLen -> ICStringLen -> Bool

Show ICStringLen

Defined in Util.ICStringLen

Methods

showsPrec :: Int -> ICStringLen -> ShowS

show :: ICStringLen -> String

showList :: [ICStringLen] -> ShowS

OrdIO ICStringLen

Defined in Util.ICStringLen

Methods

compareIO :: ICStringLen -> ICStringLen -> IO Ordering

EqIO ICStringLen

Defined in Util.ICStringLen

Methods

eqIO :: ICStringLen -> ICStringLen -> IO Bool

StringClass ICStringLen

Defined in Util.ICStringLen

Methods

toString :: ICStringLen -> String

fromString :: String -> ICStringLen

fromStringWE :: String -> WithError ICStringLen

MonadIO m => HasBinary ICStringLen m

Defined in Util.ICStringLen

Methods

writeBin :: WriteBinary m -> ICStringLen -> m ()

readBin :: ReadBinary m -> m ICStringLen

StringClass (UTF8 ICStringLen)

Defined in Util.ICStringLen

Methods

toString :: UTF8 ICStringLen -> String

fromString :: String -> UTF8 ICStringLen

fromStringWE :: String -> WithError (UTF8 ICStringLen)

newtype UTF8 bytes

Constructors

UTF8 bytes

Instances

StringClass (UTF8 ICStringLen)

Defined in Util.ICStringLen

Methods

toString :: UTF8 ICStringLen -> String

fromString :: String -> UTF8 ICStringLen

fromStringWE :: String -> WithError (UTF8 ICStringLen)

toUTF8 :: Enum byte => String -> [byte]

Converts a String into its UTF8 representation.

fromUTF8WE :: (Enum byte, MonadFail m) => [byte] -> m String

Converts a UTF8 representation of a String back into the String, catching all possible format errors.

Example: With the Haskell module Control.Monad.Error, you can instance this as (fromUTF8WE :: String -> Either String String) to get a conversion function which either succeeds (Right) or returns an error message (Left).

mkICStringLen :: Int -> (CString -> IO ()) -> IO ICStringLen

mkICStringLenExtra :: Int -> (CString -> IO extra) -> IO (ICStringLen, extra)

withICStringLen :: ICStringLen -> (Int -> CString -> IO a) -> IO a

bytesToICStringLen :: (Bytes, Int) -> IO ICStringLen

bytesFromICStringLen :: ICStringLen -> (Bytes, Int)

touchICStringLen :: ICStringLen -> IO ()

readICStringLen :: HasBinary a StateBinArea => ICStringLen -> IO a

writeToICStringLen :: HasBinary a StateBinArea => a -> IO ICStringLen