Colonnade.Types

Documentation

newtype Encoding f content a

Constructors

Encoding

Fields

getEncoding :: Vector (OneEncoding f content a)

Instances

Divisible (Encoding f content)

Contravariant (Encoding f content)

Monoid (Encoding f content a)

data Decoding f content a where

This just actually a specialization of the free applicative. Check out Control.Applicative.Free in the free library to learn more about this. The meanings of the fields are documented slightly more in the source code. Unfortunately, haddock does not play nicely with GADTs.

Constructors

DecodingPure :: !a -> Decoding f content a

DecodingAp :: !(f content) -> !(content -> Either String a) -> !(Decoding f content (a -> b)) -> Decoding f content b

Instances

Functor (Decoding f content)

Applicative (Decoding f content)

data OneEncoding f content a

Encodes a header and a cell.

Constructors

OneEncoding

Fields

oneEncodingHead :: !(f content)

oneEncodingEncode :: !(a -> content)

Instances

Contravariant (OneEncoding f content)

newtype Headed a

Isomorphic to Identity

Constructors

Headed

Fields

getHeaded :: a

Instances

Functor Headed

Foldable Headed

Eq a => Eq (Headed a)

Ord a => Ord (Headed a)

Read a => Read (Headed a)

Show a => Show (Headed a)

data Headless a

Isomorphic to Proxy

Constructors

Headless

Instances

Functor Headless

Foldable Headless

Contravariant Headless

Eq (Headless a)

Ord (Headless a)

Read (Headless a)

Show (Headless a)

data Indexed f a

Constructors

Indexed

Fields

indexedIndex :: !Int

indexedHeading :: !(f a)

Instances

Functor f => Functor (Indexed f)

Eq (f a) => Eq (Indexed f a)

Ord (f a) => Ord (Indexed f a)

Read (f a) => Read (Indexed f a)

Show (f a) => Show (Indexed f a)

data HeadingErrors content

Constructors

HeadingErrors

Fields

headingErrorsMissing :: Vector content

headers that were missing

headingErrorsDuplicate :: Vector (content, Int)

headers that occurred more than once

Instances

Eq content => Eq (HeadingErrors content)

Read content => Read (HeadingErrors content)

Show content => Show (HeadingErrors content)

(Show content, Typeable * content) => Exception (HeadingErrors content)

Monoid (HeadingErrors content)

data DecodingCellError f content

Constructors

DecodingCellError

Fields

decodingCellErrorContent :: !content

decodingCellErrorHeader :: !(Indexed f content)

decodingCellErrorMessage :: !String

Instances

(Eq content, Eq (f content)) => Eq (DecodingCellError f content)

(Read content, Read (f content)) => Read (DecodingCellError f content)

(Show content, Show (f content)) => Show (DecodingCellError f content)

data DecodingRowError f content

Constructors

DecodingRowError

Fields

decodingRowErrorRow :: !Int

decodingRowErrorError :: !(RowError f content)

Instances

(Eq content, Eq (f content)) => Eq (DecodingRowError f content)

(Read content, Read (f content)) => Read (DecodingRowError f content)

(Show content, Show (f content)) => Show (DecodingRowError f content)

newtype DecodingCellErrors f content

Constructors

DecodingCellErrors

Fields

getDecodingCellErrors :: Vector (DecodingCellError f content)

Instances

(Eq content, Eq (f content)) => Eq (DecodingCellErrors f content)

(Read content, Read (f content)) => Read (DecodingCellErrors f content)

(Show content, Show (f content)) => Show (DecodingCellErrors f content)

Monoid (DecodingCellErrors f content)

data RowError f content

Constructors

RowErrorParse !String

Error occurred parsing the document into cells

RowErrorDecode !(DecodingCellErrors f content)

Error decoding the content

RowErrorSize !Int !Int

Wrong number of cells in the row

RowErrorHeading !(HeadingErrors content)

RowErrorMinSize !Int !Int

RowErrorMalformed !String

Error decoding unicode content

Instances

(Eq content, Eq (f content)) => Eq (RowError f content)

(Read content, Read (f content)) => Read (RowError f content)

(Show content, Show (f content)) => Show (RowError f content)