Hyrax.Abif

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

See

• Source code on github
• The ABIF spec

Documentation

data Abif

A single ABIF

Constructors

Abif

Fields

• aHeader :: !Header
• aRootDir :: !Directory
• aDirs :: ![Directory]

Instances

Eq Abif

Defined in Hyrax.Abif

Methods

(==) :: Abif -> Abif -> Bool

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

Show Abif

Defined in Hyrax.Abif

Methods

showsPrec :: Int -> Abif -> ShowS

show :: Abif -> String

showList :: [Abif] -> ShowS

data Header

ABIF header

Constructors

Header

Fields

• hName :: !Text
• hVersion :: !Int

Instances

Eq Header

Defined in Hyrax.Abif

Methods

(==) :: Header -> Header -> Bool

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

Show Header

Defined in Hyrax.Abif

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

data Directory

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

Constructors

Directory

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

Defined in Hyrax.Abif

Methods

(==) :: Directory -> Directory -> Bool

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

Show Directory

Defined in Hyrax.Abif

Methods

showsPrec :: Int -> Directory -> ShowS

show :: Directory -> String

showList :: [Directory] -> ShowS

data ElemType

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

Constructors

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

Instances

Eq ElemType

Defined in Hyrax.Abif

Methods

(==) :: ElemType -> ElemType -> Bool

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

Show ElemType

Defined in Hyrax.Abif

Methods

showsPrec :: Int -> ElemType -> ShowS

show :: ElemType -> String

showList :: [ElemType] -> ShowS

getElemType :: Int -> ElemType

Get an ElemType from a elem type code

describeElemType :: Int -> (ElemType, Text)

Get the description for an ElemType