Data.ByteString.IsoBaseFileFormat.Util.BoxFields

Mini EDSL for labelled box fields. The boxfields can be Scalar or ScalarArrays.

Scalar box fields

type U64 label = Scalar Word64 label

type I64 label = Scalar Int64 label

u64 :: Word64 -> U64 label

i64 :: Int64 -> I64 label

type U32 label = Scalar Word32 label

type I32 label = Scalar Int32 label

u32 :: Word32 -> U32 label

i32 :: Int32 -> I32 label

type U16 label = Scalar Word16 label

type I16 label = Scalar Int16 label

u16 :: Word16 -> U16 label

i16 :: Int16 -> I16 label

type U8 label = Scalar Word8 label

type I8 label = Scalar Int8 label

u8 :: Word8 -> U8 label

i8 :: Int8 -> I8 label

newtype Scalar scalartype label

A numeric box field with a type level label. Note that it has a Num instance. Use the type aliases above, e.g. U8,I8,U16,I16,U32,I32,U64,I64 from above. Use either the smart constructors, e.g. u8,i8,u16,i16,u32,i32,u64,i64 or the Num instance, whereas the constructors might give a bit more safety.

Constructors

Scalar

Fields

• fromScalar :: scalartype

Instances

IsBox ChunkOffsetTable64

Associated Types

type BoxContent ChunkOffsetTable64 :: *

Methods

toBoxType :: proxy ChunkOffsetTable64 -> BoxType

IsBox ChunkOffsetTable32

Associated Types

type BoxContent ChunkOffsetTable32 :: *

Methods

toBoxType :: proxy ChunkOffsetTable32 -> BoxType

(KnownNat scalar, Num o) => FromTypeLit Nat (Scalar k o label) scalar

Methods

fromTypeLit :: proxy scalar v -> scalar

Eq scalartype => Eq (Scalar k scalartype label)

Methods

(==) :: Scalar k scalartype label -> Scalar k scalartype label -> Bool

(/=) :: Scalar k scalartype label -> Scalar k scalartype label -> Bool

Num scalartype => Num (Scalar k scalartype label)

Methods

(+) :: Scalar k scalartype label -> Scalar k scalartype label -> Scalar k scalartype label

(-) :: Scalar k scalartype label -> Scalar k scalartype label -> Scalar k scalartype label

(*) :: Scalar k scalartype label -> Scalar k scalartype label -> Scalar k scalartype label

negate :: Scalar k scalartype label -> Scalar k scalartype label

abs :: Scalar k scalartype label -> Scalar k scalartype label

signum :: Scalar k scalartype label -> Scalar k scalartype label

fromInteger :: Integer -> Scalar k scalartype label

Ord scalartype => Ord (Scalar k scalartype label)

Methods

compare :: Scalar k scalartype label -> Scalar k scalartype label -> Ordering

(<) :: Scalar k scalartype label -> Scalar k scalartype label -> Bool

(<=) :: Scalar k scalartype label -> Scalar k scalartype label -> Bool

(>) :: Scalar k scalartype label -> Scalar k scalartype label -> Bool

(>=) :: Scalar k scalartype label -> Scalar k scalartype label -> Bool

max :: Scalar k scalartype label -> Scalar k scalartype label -> Scalar k scalartype label

min :: Scalar k scalartype label -> Scalar k scalartype label -> Scalar k scalartype label

Read scalartype => Read (Scalar k scalartype label)

Methods

readsPrec :: Int -> ReadS (Scalar k scalartype label)

readList :: ReadS [Scalar k scalartype label]

readPrec :: ReadPrec (Scalar k scalartype label)

readListPrec :: ReadPrec [Scalar k scalartype label]

Show scalartype => Show (Scalar k scalartype label)

Methods

showsPrec :: Int -> Scalar k scalartype label -> ShowS

show :: Scalar k scalartype label -> String

showList :: [Scalar k scalartype label] -> ShowS

Default scalartype => Default (Scalar k scalartype label)

Methods

def :: Scalar k scalartype label

IsBoxContent (Scalar k Int64 label)

Methods

boxSize :: Scalar k Int64 label -> BoxSize

boxBuilder :: Scalar k Int64 label -> Builder

IsBoxContent (Scalar k Int32 label)

Methods

boxSize :: Scalar k Int32 label -> BoxSize

boxBuilder :: Scalar k Int32 label -> Builder

IsBoxContent (Scalar k Int16 label)

Methods

boxSize :: Scalar k Int16 label -> BoxSize

boxBuilder :: Scalar k Int16 label -> Builder

IsBoxContent (Scalar k Int8 label)

Methods

boxSize :: Scalar k Int8 label -> BoxSize

boxBuilder :: Scalar k Int8 label -> Builder

IsBoxContent (Scalar k Word64 label)

Methods

boxSize :: Scalar k Word64 label -> BoxSize

boxBuilder :: Scalar k Word64 label -> Builder

IsBoxContent (Scalar k Word32 label)

Methods

boxSize :: Scalar k Word32 label -> BoxSize

boxBuilder :: Scalar k Word32 label -> Builder

IsBoxContent (Scalar k Word16 label)

Methods

boxSize :: Scalar k Word16 label -> BoxSize

boxBuilder :: Scalar k Word16 label -> Builder

IsBoxContent (Scalar k Word8 label)

Methods

boxSize :: Scalar k Word8 label -> BoxSize

boxBuilder :: Scalar k Word8 label -> Builder

type BoxContent ChunkOffsetTable64

type BoxContent ChunkOffsetTable64 = ChunkOffsetTable64

type BoxContent ChunkOffsetTable32

type BoxContent ChunkOffsetTable32 = ChunkOffsetTable32

type BoxTypeSymbol * ChunkOffsetTable64

type BoxTypeSymbol * ChunkOffsetTable64 = "co64"

type BoxTypeSymbol * ChunkOffsetTable32

type BoxTypeSymbol * ChunkOffsetTable32 = "stco"

relabelScalar :: Scalar t l -> Scalar t l'

Relabel a scalar value, e.g. convert a Scalar U32 "foo" to a Scalar U32 "bar".

Array fields

type U64Arr label size = ScalarArray label size Word64

u64Arr :: (KnownNat size, KnownSymbol label) => [Word64] -> U64Arr label size

type I64Arr label size = ScalarArray label size Int64

i64Arr :: (KnownNat size, KnownSymbol label) => [Int64] -> I64Arr label size

type U32Arr label size = ScalarArray label size Word32

u32Arr :: (KnownNat size, KnownSymbol label) => [Word32] -> U32Arr label size

type I32Arr label size = ScalarArray label size Int32

i32Arr :: (KnownNat size, KnownSymbol label) => [Int32] -> I32Arr label size

type U16Arr label size = ScalarArray label size Word16

u16Arr :: (KnownNat size, KnownSymbol label) => [Word16] -> U16Arr label size

type I16Arr label size = ScalarArray label size Int16

i16Arr :: (KnownNat size, KnownSymbol label) => [Int16] -> I16Arr label size

type U8Arr label size = ScalarArray label size Word8

u8Arr :: (KnownNat size, KnownSymbol label) => [Word8] -> U8Arr label size

type I8Arr label size = ScalarArray label size Int8

i8Arr :: (KnownNat size, KnownSymbol label) => [Int8] -> I8Arr label size

newtype ScalarArray label len o where

A box field that is an array of Scalars with a type level label. Use the type aliases, e.g. U8Arr,I8Arr,U16Arr,I16Arr,U32Arr,I32Arr,U64Arr,I64Arr from above. Use the smart constructors, e.g. u8Arr,i8Arr,u16Arr,i16Arr,u32Arr,i32Arr,u64Arr,i64Arr .

Constructors

ScalarArray :: Vector o -> ScalarArray label n o

Instances

(KnownSymbol label, SingI [Nat] arr, Num o, SingKind [Nat], KnownNat len, (~) Nat len (Length Nat arr)) => FromTypeLit [Nat] (ScalarArray Symbol label len o) arr

Methods

fromTypeLit :: proxy arr v -> arr

Eq o => Eq (ScalarArray k label len o)

Methods

(==) :: ScalarArray k label len o -> ScalarArray k label len o -> Bool

(/=) :: ScalarArray k label len o -> ScalarArray k label len o -> Bool

Show o => Show (ScalarArray k label len o)

Methods

showsPrec :: Int -> ScalarArray k label len o -> ShowS

show :: ScalarArray k label len o -> String

showList :: [ScalarArray k label len o] -> ShowS

(Default o, KnownNat len) => Default (ScalarArray k label len o)

Methods

def :: ScalarArray k label len o

(Num o, IsBoxContent (Scalar k o label)) => IsBoxContent (ScalarArray k label len o)

Methods

boxSize :: ScalarArray k label len o -> BoxSize

boxBuilder :: ScalarArray k label len o -> Builder

fromList :: forall label n o. (KnownSymbol label, KnownNat n) => [o] -> ScalarArray label n o

Internal function

Constant fields

data Constant o v where

Wrapper around a field, e.g. a Scalar or ScalarArray, with a type level value. The wrapped content must implement FromTypeLit. To get the value of a Constant use fromTypeLit.

Constructors

Constant :: Constant o v

Instances

Default (Constant k k1 o v)

Methods

def :: Constant k k1 o v

(IsBoxContent o, FromTypeLit k o v) => IsBoxContent (Constant k * o v)

Methods

boxSize :: Constant k * o v -> BoxSize

boxBuilder :: Constant k * o v -> Builder

Template Fields

data Template o v where

Fields with default values that can be overriden with custom value. Like Constant this is a wrapper around a field, e.g. a Scalar or ScalarArray, with a type level default value. The wrapped content must implement FromTypeLit.

Constructors

Template :: Template o v

Custom :: !o -> Template o v

Instances

Default (Template k o v)

Methods

def :: Template k o v

(IsBoxContent o, FromTypeLit k o v) => IsBoxContent (Template k o v)

Methods

boxSize :: Template k o v -> BoxSize

boxBuilder :: Template k o v -> Builder

templateValue :: FromTypeLit o v => Template o v -> o

Get a value from a Template.

Conversion from type-level numbers and lists to values

class FromTypeLit o v where

Types that can be constructed from type level value representations.

Minimal complete definition

fromTypeLit

Methods

fromTypeLit :: proxy o v -> o

Instances

KnownSymbol str => FromTypeLit Symbol Text str

Methods

fromTypeLit :: proxy str v -> str

KnownSymbol str => FromTypeLit Symbol (U32Text label) str

Methods

fromTypeLit :: proxy str v -> str

(KnownNat scalar, Num o) => FromTypeLit Nat (Scalar k o label) scalar

Methods

fromTypeLit :: proxy scalar v -> scalar

(KnownSymbol label, SingI [Nat] arr, Num o, SingKind [Nat], KnownNat len, (~) Nat len (Length Nat arr)) => FromTypeLit [Nat] (ScalarArray Symbol label len o) arr

Methods

fromTypeLit :: proxy arr v -> arr

String/Text field types

newtype FixSizeText len label where

A fixed size string, the first byte is the string length, after the String, the field is padded with 0 bytes. The string must be in UTF8 format.

Constructors

FixSizeText :: Text -> FixSizeText len label

Instances

IsTextSize len => Default (FixSizeText len label)

Methods

def :: FixSizeText len label

IsTextSize len => IsBoxContent (FixSizeText len label)

Methods

boxSize :: FixSizeText len label -> BoxSize

boxBuilder :: FixSizeText len label -> Builder

type IsTextSize len = (KnownNat len, 1 <= len, len <= 255)

A constraint that matches type level numbers that are valid text sizes for FixSizeTexts.

newtype U32Text label where

Four character strings embedded in a uint32.

Constructors

U32Text :: Word32 -> U32Text label

Instances

KnownSymbol str => FromTypeLit Symbol (U32Text label) str

Methods

fromTypeLit :: proxy str v -> str

IsString (U32Text label)

Methods

fromString :: String -> U32Text label

Default (U32Text label)

Methods

def :: U32Text label

IsBoxContent (U32Text label)

Methods

boxSize :: U32Text label -> BoxSize

boxBuilder :: U32Text label -> Builder