backend-0.1.0.0
LicenseAGPL-3
Maintainerstu235271@mail.uni-kiel.de stu236925@mail.uni-kiel.de
Safe HaskellNone
LanguageHaskell2010

Docs.TextElement

Description

This module contains the definitions for the contents of a documen trees text nodes.

Synopsis

Documentation

newtype TextElementID Source #

ID for a text element

Constructors

TextElementID 

Fields

Instances

Instances details
FromJSON TextElementID Source # 
Instance details

Defined in Docs.TextElement

Methods

parseJSON :: Value -> Parser TextElementID

parseJSONList :: Value -> Parser [TextElementID]

omittedField :: Maybe TextElementID

ToJSON TextElementID Source # 
Instance details

Defined in Docs.TextElement

Methods

toJSON :: TextElementID -> Value

toEncoding :: TextElementID -> Encoding

toJSONList :: [TextElementID] -> Value

toEncodingList :: [TextElementID] -> Encoding

omitField :: TextElementID -> Bool

Hashable TextElementID Source # 
Instance details

Defined in Docs.TextElement

Methods

updateHash :: Ctx -> TextElementID -> Ctx Source #

hash :: TextElementID -> Hash Source #

Show TextElementID Source # 
Instance details

Defined in Docs.TextElement

Methods

showsPrec :: Int -> TextElementID -> ShowS #

show :: TextElementID -> String #

showList :: [TextElementID] -> ShowS #

Eq TextElementID Source # 
Instance details

Defined in Docs.TextElement

Methods

(==) :: TextElementID -> TextElementID -> Bool #

(/=) :: TextElementID -> TextElementID -> Bool #

Ord TextElementID Source # 
Instance details

Defined in Docs.TextElement

Methods

compare :: TextElementID -> TextElementID -> Ordering #

(<) :: TextElementID -> TextElementID -> Bool #

(<=) :: TextElementID -> TextElementID -> Bool #

(>) :: TextElementID -> TextElementID -> Bool #

(>=) :: TextElementID -> TextElementID -> Bool #

max :: TextElementID -> TextElementID -> TextElementID #

min :: TextElementID -> TextElementID -> TextElementID #

FromHttpApiData TextElementID Source # 
Instance details

Defined in Docs.TextElement

Methods

parseUrlPiece :: Text -> Either Text TextElementID

parseHeader :: ByteString -> Either Text TextElementID

parseQueryParam :: Text -> Either Text TextElementID

ToParamSchema TextElementID Source # 
Instance details

Defined in Docs.TextElement

Methods

toParamSchema :: Proxy TextElementID -> Schema

ToSchema TextElementID Source # 
Instance details

Defined in Docs.TextElement

Methods

declareNamedSchema :: Proxy TextElementID -> Declare (Definitions Schema) NamedSchema

data TextElement Source #

Contains metadata about a text element.

Constructors

TextElement 

Fields

Instances

Instances details
FromJSON TextElement Source # 
Instance details

Defined in Docs.TextElement

Methods

parseJSON :: Value -> Parser TextElement

parseJSONList :: Value -> Parser [TextElement]

omittedField :: Maybe TextElement

ToJSON TextElement Source # 
Instance details

Defined in Docs.TextElement

Methods

toJSON :: TextElement -> Value

toEncoding :: TextElement -> Encoding

toJSONList :: [TextElement] -> Value

toEncodingList :: [TextElement] -> Encoding

omitField :: TextElement -> Bool

Generic TextElement Source # 
Instance details

Defined in Docs.TextElement

Associated Types

type Rep TextElement 
Instance details

Defined in Docs.TextElement

type Rep TextElement = D1 ('MetaData "TextElement" "Docs.TextElement" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextElement" 'PrefixI 'True) (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElementID) :*: (S1 ('MetaSel ('Just "textElementKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElementKind) :*: S1 ('MetaSel ('Just "textElementType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElementType))))

Methods

from :: TextElement -> Rep TextElement x #

to :: Rep TextElement x -> TextElement #

ToSchema TextElement Source # 
Instance details

Defined in Docs.TextElement

Methods

declareNamedSchema :: Proxy TextElement -> Declare (Definitions Schema) NamedSchema

type Rep TextElement Source # 
Instance details

Defined in Docs.TextElement

type Rep TextElement = D1 ('MetaData "TextElement" "Docs.TextElement" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextElement" 'PrefixI 'True) (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElementID) :*: (S1 ('MetaSel ('Just "textElementKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElementKind) :*: S1 ('MetaSel ('Just "textElementType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElementType))))

type TextElementKind = Text Source #

type TextElementType = Text Source #

data TextElementRef Source #

Scoped identifier for a text element

Constructors

TextElementRef 

Fields

Instances

Instances details
FromJSON TextElementRef Source # 
Instance details

Defined in Docs.TextElement

Methods

parseJSON :: Value -> Parser TextElementRef

parseJSONList :: Value -> Parser [TextElementRef]

omittedField :: Maybe TextElementRef

ToJSON TextElementRef Source # 
Instance details

Defined in Docs.TextElement

Methods

toJSON :: TextElementRef -> Value

toEncoding :: TextElementRef -> Encoding

toJSONList :: [TextElementRef] -> Value

toEncodingList :: [TextElementRef] -> Encoding

omitField :: TextElementRef -> Bool

Generic TextElementRef Source # 
Instance details

Defined in Docs.TextElement

Associated Types

type Rep TextElementRef 
Instance details

Defined in Docs.TextElement

type Rep TextElementRef = D1 ('MetaData "TextElementRef" "Docs.TextElement" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextElementRef" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DocumentID) :*: S1 ('MetaSel ('Just "textElementID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElementID)))

Methods

from :: TextElementRef -> Rep TextElementRef x #

to :: Rep TextElementRef x -> TextElementRef #

Eq TextElementRef Source # 
Instance details

Defined in Docs.TextElement

Methods

(==) :: TextElementRef -> TextElementRef -> Bool #

(/=) :: TextElementRef -> TextElementRef -> Bool #

ToSchema TextElementRef Source # 
Instance details

Defined in Docs.TextElement

Methods

declareNamedSchema :: Proxy TextElementRef -> Declare (Definitions Schema) NamedSchema

type Rep TextElementRef Source # 
Instance details

Defined in Docs.TextElement

type Rep TextElementRef = D1 ('MetaData "TextElementRef" "Docs.TextElement" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextElementRef" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DocumentID) :*: S1 ('MetaSel ('Just "textElementID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElementID)))

prettyPrintTextElementRef :: TextElementRef -> String Source #