Haste.Binary

Handling of Javascript-native binary blobs.

Generics borrowed from the binary package by Lennart Kolmodin (released under BSD3)

Documentation

type Put = PutM ()

data PutM a

Instances

Monad PutM

Functor PutM

Applicative PutM

putWord8 :: Word8 -> Put

putWord16le :: Word16 -> Put

putWord32le :: Word32 -> Put

putInt8 :: Int8 -> Put

putInt16le :: Int16 -> Put

putInt32le :: Int32 -> Put

putFloat32le :: Float -> Put

putFloat64le :: Double -> Put

putBlob :: Blob -> Put

putJSString :: JSString -> Put

Serialize a JSString as UTF-16 (somewhat) efficiently.

runPut :: Put -> Blob

data Get a

Instances

Monad Get

Functor Get

Applicative Get

getWord8 :: Get Word8

getWord16le :: Get Word16

getWord32le :: Get Word32

getInt8 :: Get Int8

getInt16le :: Get Int16

getInt32le :: Get Int32

getFloat32le :: Get Float

getFloat64le :: Get Double

getBytes :: Int -> Get BlobData

getJSString :: Int -> Get JSString

skip :: Int -> Get ()

Skip n bytes of input.

runGet :: Get a -> BlobData -> Either String a

class Monad m => MonadBlob m where

Methods

getBlobData :: Blob -> m BlobData

Retrieve the raw data from a blob.

getBlobText' :: Blob -> m JSString

Interpret a blob as UTF-8 text, as a JSString.

Instances

MonadBlob CIO

MonadBlob Server

MonadBlob Client

class Binary a where

Somewhat efficient serializationdeserialization tofrom binary Blobs. The layout of the binaries producedread by getput and encode/decode may change between versions. If you need a stable binary format, you should make your own using the primitives in Haste.Binary.Get/Put.

Minimal complete definition

Nothing

Methods

get :: Get a

put :: a -> Put

Instances

Binary Char

Binary Double

Binary Float

Binary Int

Binary Int8

Binary Int16

Binary Int32

Binary Word8

Binary Word16

Binary Word32

Binary ()

Binary JSString

Binary Blob

Binary a => Binary [a]

Binary a => Binary (Maybe a)

(Binary a, Binary b) => Binary (Either a b)

(Binary a, Binary b) => Binary (a, b)

getBlobText :: MonadBlob m => Blob -> m String

Interpret a blob as UTF-8 text.

data Blob

A JavaScript Blob on the client, a ByteString on the server.

Instances

FromAny Blob

ToAny Blob

Binary Blob

data BlobData

In a browser context, BlobData is essentially a DataView, with an accompanying offset and length for fast slicing. In a server context, it is simply a ByteString.

Instances

FromAny BlobData

ToAny BlobData

blobSize :: Blob -> Int

The size, in bytes, of the contents of the given blob.

blobDataSize :: BlobData -> Int

The size, in bytes, of the contents of the given blob data.

toByteString :: BlobData -> ByteString

Convert a BlobData to a ByteString. Only usable server-side.

toBlob :: BlobData -> Blob

Convert a piece of BlobData back into a Blob.

strToBlob :: JSString -> Blob

Create a Blob from a JSString.

encode :: Binary a => a -> Blob

Encode any serializable data into a Blob.

decode :: Binary a => BlobData -> Either String a

Decode any deserializable data from a BlobData.

decodeBlob :: (MonadBlob m, Binary a) => Blob -> m (Either String a)

Decode a Blob into some deserializable value, inconveniently locked up inside the CIO monad (or any other concurrent monad) due to the somewhat special way JavaScript uses to deal with binary data.