forms-data-format-0.3: Parse and serialize FDF, the Forms Data Format
Safe HaskellNone
LanguageHaskell2010

Text.FDF

Description

Parse and serialize between FDF files and `Map [Text] Text`.

Synopsis

Documentation

data FDF Source #

Parsed FDF data structure

Constructors

FDF ByteString Field ByteString 

Instances

Instances details
Show FDF Source # 
Instance details

Defined in Text.FDF

Methods

showsPrec :: Int -> FDF -> ShowS #

show :: FDF -> String #

showList :: [FDF] -> ShowS #

data Field Source #

The body of FDF is a tree of nestable Fields.

Constructors

Field 

Fields

Instances

Instances details
Show Field Source # 
Instance details

Defined in Text.FDF

Methods

showsPrec :: Int -> Field -> ShowS #

show :: Field -> String #

showList :: [Field] -> ShowS #

Eq Field Source # 
Instance details

Defined in Text.FDF

Methods

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

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

Ord Field Source # 
Instance details

Defined in Text.FDF

Methods

compare :: Field -> Field -> Ordering #

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

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

(>) :: Field -> Field -> Bool #

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

max :: Field -> Field -> Field #

min :: Field -> Field -> Field #

data FieldContent Source #

Constructors

FieldValue Text 
Children [Field] 

Instances

Instances details
Show FieldContent Source # 
Instance details

Defined in Text.FDF

Methods

showsPrec :: Int -> FieldContent -> ShowS #

show :: FieldContent -> String #

showList :: [FieldContent] -> ShowS #

Eq FieldContent Source # 
Instance details

Defined in Text.FDF

Methods

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

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

Ord FieldContent Source # 
Instance details

Defined in Text.FDF

Methods

compare :: FieldContent -> FieldContent -> Ordering #

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

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

(>) :: FieldContent -> FieldContent -> Bool #

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

max :: FieldContent -> FieldContent -> FieldContent #

min :: FieldContent -> FieldContent -> FieldContent #

insert :: NonEmpty Text -> Text -> FDF -> FDF Source #

Insert a value at a new path into the FDF

delete :: NonEmpty Text -> Text -> FDF -> FDF Source #

Delete an existing field at the given path from the FDF

update :: NonEmpty Text -> Text -> Text -> FDF -> FDF Source #

Update a value at a new path into the FDF

mapWithKey :: ([Text] -> Text -> Text) -> FDF -> FDF Source #

mapFieldWithKey :: ([Text] -> Text -> Text) -> Field -> Field Source #

foldMapWithKey :: Monoid a => ([Text] -> Text -> a) -> FDF -> a Source #

foldMapFieldWithKey :: Monoid a => ([Text] -> Text -> a) -> Field -> a Source #

traverseWithKey :: Applicative f => ([Text] -> Text -> f Text) -> FDF -> f FDF Source #

traverseFieldWithKey :: Applicative f => ([Text] -> Text -> f Text) -> Field -> f Field Source #

parse :: ByteString -> Either String FDF Source #

serialize :: FDF -> ByteString Source #