OpenAFP-1.1: IBM AFP document format parser and generator Source code Contents Index

OpenAFP.Types.Buffer Portability non-portable (GHC-only) Stability experimental Maintainer audreyt@audreyt.org

Description

This module handles sized binary buffers.

Synopsis

class (Show a, Typeable a) => Buf a where mkBuf :: BS -> a packBuf :: a -> BS newtype Buffer0 = Buf0 { fromBuf0 :: BS } newtype Buffer1 = Buf1 { fromBuf1 :: BS } newtype Buffer2 = Buf2 { fromBuf2 :: BS }

Documentation

class (Show a, Typeable a) => Buf a where Source

The Buf class represents buffers, with the leading bytes representing its length. Methods mkBuf :: BS -> a Source packBuf :: a -> BS Source Instances Buf Buffer2 Buf Buffer1 Buf Buffer0

newtype Buffer0 Source

Buffer0, being a simple BS, is of unlimited length. Constructors Buf0 fromBuf0 :: BS Instances Show Buffer0 Typeable Buffer0 Storable NStr Binary Buffer0 Buf Buffer0

newtype Buffer1 Source

Buffer1 uses one byte as length, hence is at most 254 bytes long. Constructors Buf1 fromBuf1 :: BS Instances Show Buffer1 Typeable Buffer1 Binary Buffer1 Buf Buffer1

newtype Buffer2 Source

Buffer2 uses two bytes; it can store up to 65535 bytes. Constructors Buf2 fromBuf2 :: BS Instances Show Buffer2 Typeable Buffer2 Binary Buffer2 Buf Buffer2

Produced by Haddock version 2.3.0