Data.ByteString.IsoBaseFileFormat.Boxes.Brand

Brand/Box-validation

Documentation

class KnownNat (GetVersion brand) => IsBrand brand

A class that describes (on the type level) how a box can be nested into other boxes (see 'Boxes).

Associated Types

type BoxLayout brand :: BoxForrest

type GetVersion brand :: Nat

Instances

KnownNat v => IsBrand * (Dash v)

A BoxLayout which contains the stuff needed for the dash brand. TODO incomplete

Associated Types

type BoxLayout (Dash v) (brand :: Dash v) :: BoxForrest

type GetVersion (Dash v) (brand :: Dash v) :: Nat

type ValidBox b t = IsBrandConform b (Just t) '[]

Convenience wrapper around (IsBrandConform b ('Just t) '[])

type ValidContainerBox b t ts = IsBrandConform b (Just t) ts

Convenience wrapper around (IsBrandConform b ('Just t) ts)

type ValidTopLevel b ts = IsBrandConform b Nothing ts

Convenience wrapper around (IsBrandConform b 'Nothing ts)

type family IsBrandConform (b :: Type) (parent :: Maybe Type) (ts :: [Type]) :: Constraint where ...

Boxes that valid according to the box structure defined in a IsBrand instance, i.e. where IsBrandConform holds.

Equations

IsBrandConform b Nothing ts = IsBrandConformImpl b (TopLevel b) ts (BoxLayout b)

IsBrandConform b (Just parent) ts = IsBrandConformImpl b parent ts (LookUpSubtrees parent (BoxLayout b))

data BoxTree

Define the cardinality and valid child boxes of a box.

Constructors

OnceOptional Type BoxForrest

OnceMandatory Type BoxForrest

SomeOptional Type BoxForrest

SomeMandatory Type BoxForrest

type BoxForrest = [BoxTree]

A list of BoxTrees

type OM b bs = OnceMandatory b bs

Mandatory, container box, exactly one

type OM_ b = OnceMandatory b '[]

Mandatory, exactly one, no children

type OO b bs = OnceOptional b bs

Optional, container box, zero or one

type OO_ b = OnceOptional b '[]

Optional, zero or one, no children

type SM b bs = SomeMandatory b bs

Mandatory, container box, one or more

type SM_ b = SomeMandatory b '[]

Mandatory, one or more, no children

type SO b bs = SomeOptional b bs

Optional, container box, zero or more

type SO_ b = SomeOptional b '[]

Optional, zero or more, no children