Data.MessagePack.Base

Low Level Interface to MessagePack C API

Simple Buffer

type SimpleBuffer = ForeignPtr ()

newSimpleBuffer :: IO SimpleBuffer

Create a new Simple Buffer. It will be deleted automatically.

simpleBufferData :: SimpleBuffer -> IO ByteString

Get data of Simple Buffer.

Serializer

type Packer = ForeignPtr ()

newPacker :: SimpleBuffer -> IO Packer

Create new Packer. It will be deleted automatically.

packU8 :: Packer -> Word8 -> IO Int

packU16 :: Packer -> Word16 -> IO Int

packU32 :: Packer -> Word32 -> IO Int

packU64 :: Packer -> Word64 -> IO Int

packS8 :: Packer -> Int8 -> IO Int

packS16 :: Packer -> Int16 -> IO Int

packS32 :: Packer -> Int32 -> IO Int

packS64 :: Packer -> Int64 -> IO Int

packTrue :: Packer -> IO Int

packFalse :: Packer -> IO Int

packInt :: Integral a => Packer -> a -> IO Int

Pack an integral data.

packDouble :: Packer -> Double -> IO Int

Pack a double data.

packNil :: Packer -> IO Int

Pack a nil.

packBool :: Packer -> Bool -> IO Int

Pack a bool data.

packArray :: Packer -> Int -> IO Int

packArray p n starts packing an array. Next n data will consist this array.

packMap :: Packer -> Int -> IO Int

packMap p n starts packing a map. Next n pairs of data (2*n data) will consist this map.

packRAW :: Packer -> Int -> IO Int

packRAW p n starts packing a byte sequence. Next total n bytes of packRAWBody call will consist this sequence.

packRAWBody :: Packer -> ByteString -> IO Int

Pack a byte sequence.

packRAW' :: Packer -> ByteString -> IO Int

Pack a single byte stream. It calls packRAW and packRAWBody.

Stream Deserializer

type Unpacker = ForeignPtr ()

defaultInitialBufferSize :: Int

newUnpacker :: Int -> IO Unpacker

newUnpacker initialBufferSize creates a new Unpacker. It will be deleted automatically.

unpackerReserveBuffer :: Unpacker -> Int -> IO Bool

unpackerReserveBuffer up size reserves at least size bytes of buffer.

unpackerBuffer :: Unpacker -> IO (Ptr CChar)

Get a pointer of unpacker buffer.

unpackerBufferCapacity :: Unpacker -> IO Int

Get size of allocated buffer.

unpackerBufferConsumed :: Unpacker -> Int -> IO ()

unpackerBufferConsumed up size notices that writed size bytes to buffer.

unpackerFeed :: Unpacker -> ByteString -> IO ()

Write byte sequence to Unpacker. It is utility funciton, calls unpackerReserveBuffer, unpackerBuffer and unpackerBufferConsumed.

unpackerExecute :: Unpacker -> IO Int

Execute deserializing. It returns 0 when buffer contains not enough bytes, returns 1 when succeeded, returns negative value when it failed.

unpackerData :: Unpacker -> IO Object

Returns a deserialized object when unpackerExecute returned 1.

unpackerReleaseZone :: Unpacker -> IO Zone

Release memory zone. The returned zone must be freed by calling freeZone.

unpackerResetZone :: Unpacker -> IO ()

Free memory zone used by Unapcker.

unpackerReset :: Unpacker -> IO ()

Reset Unpacker state except memory zone.

unpackerMessageSize :: Unpacker -> IO Int

Returns number of bytes of sequence of deserializing object.

MessagePack Object

data Object

Object Representation of MessagePack data.

Constructors

ObjectNil

ObjectBool Bool

ObjectInteger Int

ObjectDouble Double

ObjectRAW ByteString

ObjectArray [Object]

ObjectMap [(Object, Object)]

Instances

Show Object

OBJECT Object

packObject :: Packer -> Object -> IO ()

Pack a Object.

data UnpackReturn

Constructors

UnpackContinue

not enough bytes to unpack object

UnpackParseError

got invalid bytes

UnpackError

other error

Instances

Eq UnpackReturn

Show UnpackReturn

unpackObject :: Zone -> ByteString -> IO (Either UnpackReturn (Int, Object))

Unpack a single MessagePack object from byte sequence.

Memory Zone

type Zone = Ptr ()

newZone :: IO Zone

Create a new memory zone. It must be freed manually.

freeZone :: Zone -> IO ()

Free a memory zone.

withZone :: (Zone -> IO a) -> IO a

Create a memory zone, then execute argument, then free memory zone.