Copyright	(c) HyraxBio 2018
License	BSD3
Maintainer	andre@hyraxbio.co.za, andre@andrevdm.com
Stability	beta
Safe Haskell	Safe
Language	Haskell2010

Hyrax.Abif

Description

This module contains the core types for working with AB1 files.

See

Synopsis

Documentation

A single ABIF

Constructors

Abif
Fields aHeader :: !Header aRootDir :: !Directory aDirs :: ![Directory]

Instances

Eq Abif Source #
Instance details Defined in Hyrax.Abif Methods (==) :: Abif -> Abif -> Bool # (/=) :: Abif -> Abif -> Bool #
Show Abif Source #
Instance details Defined in Hyrax.Abif Methods showsPrec :: Int -> Abif -> ShowS # show :: Abif -> String # showList :: [Abif] -> ShowS #

ABIF header

Constructors

Header
Fields hName :: !Text hVersion :: !Int

ABIF directory entry. The dData field contains the data for the entry

Constructors

Fields

dTagName :: !Text
Tag name
dTagNum :: !Int
Tag number, see e.g. how DATA entries use this
dElemType :: !ElemType
Type of an element
dElemTypeCode :: !Int
Integer value of dElemType
dElemTypeDesc :: !Text
Description of dElemType
dElemSize :: !Int
Size in bytes of each element
dElemNum :: !Int
Number of elements in the data. See the spec per data type. E.g. for a string this is the number of characters
dDataSize :: !Int
Number of bytes in the data
dDataOffset :: !Int
Offset of this directory entry's data in the file. For data that is four bytes or less, the data itself is stored in this field. This value will be recalculated when writing an ABIF so you do not need to manually set it.
dData :: !ByteString
The entry's data
dDataDebug :: ![Text]
Optinal debug data, populated by getDebug when a ABIF is parsed

Instances

Eq Directory Source #
Instance details Defined in Hyrax.Abif Methods (==) :: Directory -> Directory -> Bool # (/=) :: Directory -> Directory -> Bool #
Show Directory Source #
Instance details Defined in Hyrax.Abif Methods showsPrec :: Int -> Directory -> ShowS # show :: Directory -> String # showList :: [Directory] -> ShowS #

Type of the elements in a directory entry. See the spec for details on each type if required.

Instances

Eq ElemType Source #
Instance details Defined in Hyrax.Abif Methods (==) :: ElemType -> ElemType -> Bool # (/=) :: ElemType -> ElemType -> Bool #
Show ElemType Source #
Instance details Defined in Hyrax.Abif Methods showsPrec :: Int -> ElemType -> ShowS # show :: ElemType -> String # showList :: [ElemType] -> ShowS #

Get an ElemType from a elem type code

Get the description for an ElemType

Eq Header Source #
Instance details Defined in Hyrax.Abif Methods (==) :: Header -> Header -> Bool # (/=) :: Header -> Header -> Bool #
Show Header Source #
Instance details Defined in Hyrax.Abif Methods showsPrec :: Int -> Header -> ShowS # show :: Header -> String # showList :: [Header] -> ShowS #

ElemUnknown
ElemCustom
ElemByte
ElemChar
ElemWord
ElemShort
ElemLong
ElemFloat
ElemDouble
ElemDate
ElemTime
ElemPString
ElemCString
ElemThumb
ElemBool
ElemRationalUnsupported
ElemBCDUnsupported
ElemPointUnsupported
ElemRectUnsupported
ElemVPointUnsupported
ElemVRectUnsupported
ElemTagUnsupported
ElemDeltaCompUnsupported
ElemLZWCompUnsupported
ElemCompressedDataUnsupported
ElemRoot