Safe Haskell	None
Language	Haskell2010

Data.EDN

Contents

EDN AST
Encoding to EDN AST
Decoding EDN AST
- AST-parsing wrappers
- Additional helpers

Synopsis

decodeText :: (FromEDN a, Monad m) => String -> Text -> m a
encodeText :: ToEDN a => a -> Text
parseText :: Monad m => String -> Text -> m TaggedValue
renderText :: TaggedValue -> Text
type TaggedValue = Tagged Text Value
data Tagged tag a
- = Tagged !tag !tag !a
- | NoTag !a
stripTag :: Tagged tag a -> a
data Value
- = Nil
- | Boolean !Bool
- | String !Text
- | Character !Char
- | Symbol !Text !Text
- | Keyword !Text
- | Integer !Int
- | Floating !Double
- | List !EDNList
- | Vec !EDNVec
- | Map !EDNMap
- | Set !EDNSet
type EDNList = [TaggedValue]
type EDNVec = Vector TaggedValue
type EDNMap = Map TaggedValue TaggedValue
type EDNSet = Set TaggedValue
mkList :: Foldable f => f TaggedValue -> Value
mkVec :: Foldable f => f TaggedValue -> Value
mkMap :: Foldable f => f (TaggedValue, TaggedValue) -> Value
mkSet :: Foldable f => f TaggedValue -> Value
class ToEDN a where
- toEDN :: a -> TaggedValue
- toEDNv :: a -> Value
toEDNtagged :: ToEDN a => Text -> Text -> a -> TaggedValue
class FromEDN a where
- parseEDN :: TaggedValue -> Parser a
- parseEDNv :: Value -> Parser a
fromEDN :: (FromEDN a, Monad m) => TaggedValue -> m a
withTagged :: Text -> Text -> (Value -> Parser a) -> TaggedValue -> Parser a
withNoTag :: (Value -> Parser a) -> TaggedValue -> Parser a
withNil :: Parser a -> Value -> Parser a
withBoolean :: (Bool -> Parser a) -> Value -> Parser a
withString :: (Text -> Parser a) -> Value -> Parser a
withCharacter :: (Char -> Parser a) -> Value -> Parser a
withSymbol :: (Text -> Text -> Parser a) -> Value -> Parser a
withKeyword :: (Text -> Parser a) -> Value -> Parser a
withTextual :: (Text -> Parser a) -> Value -> Parser a
withInteger :: (Int -> Parser a) -> Value -> Parser a
withIntegral :: Integral i => (i -> Parser a) -> Value -> Parser a
withFloating :: (Double -> Parser a) -> Value -> Parser a
withFractional :: Fractional f => (f -> Parser a) -> Value -> Parser a
withList :: (EDNList -> Parser a) -> Value -> Parser a
withVec :: (EDNVec -> Parser a) -> Value -> Parser a
withMap :: (EDNMap -> Parser a) -> Value -> Parser a
withSet :: (EDNSet -> Parser a) -> Value -> Parser a
unexpected :: Value -> Label -> Parser a
vecGet :: FromEDN a => Int -> EDNVec -> Parser a
mapGetKeyword :: FromEDN a => Text -> EDNMap -> Parser a
mapGetString :: FromEDN a => Text -> EDNMap -> Parser a
mapGetSymbol :: FromEDN a => Text -> EDNMap -> Parser a
mapGetSymbolNS :: FromEDN a => Text -> Text -> EDNMap -> Parser a

Documentation

decodeText #

Arguments

:: (FromEDN a, Monad m)
=> String	Source name, for megaparsec error reports e.g. `pathto/file.edn` or `stdin`
-> Text	EDN document body
-> m a

Decode EDN document into AST and parse value using its FromEDN instance.

encodeText :: ToEDN a => a -> Text #

Convert value to AST using ToEDN instance and render it.

EDN AST

parseText #

Arguments

:: Monad m
=> String	Source name, for megaparsec error reports e.g. `pathto/file.edn` or `stdin`
-> Text	EDN document body
-> m TaggedValue

renderText :: TaggedValue -> Text #

Render EDN document to Text

type TaggedValue = Tagged Text Value #

data Tagged tag a #

Constructors

Tagged !tag !tag !a	#prefix/tag value
NoTag !a	value

Instances

FromEDN TaggedValue #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser TaggedValue # parseEDNv :: Value -> Parser TaggedValue #
ToEDN TaggedValue #
Instance details Defined in Data.EDN.Class Methods toEDN :: TaggedValue -> TaggedValue # toEDNv :: TaggedValue -> Value #
Functor (Tagged tag) #
Instance details Defined in Data.EDN.AST.Types.Tagged Methods fmap :: (a -> b) -> Tagged tag a -> Tagged tag b # (<$) :: a -> Tagged tag b -> Tagged tag a #
(Eq tag, Eq a) => Eq (Tagged tag a) #
Instance details Defined in Data.EDN.AST.Types.Tagged Methods (==) :: Tagged tag a -> Tagged tag a -> Bool # (/=) :: Tagged tag a -> Tagged tag a -> Bool #
(Data tag, Data a) => Data (Tagged tag a) #
Instance details Defined in Data.EDN.AST.Types.Tagged Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tagged tag a -> c (Tagged tag a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Tagged tag a) # toConstr :: Tagged tag a -> Constr # dataTypeOf :: Tagged tag a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Tagged tag a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Tagged tag a)) # gmapT :: (forall b. Data b => b -> b) -> Tagged tag a -> Tagged tag a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Tagged tag a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tagged tag a -> r # gmapQ :: (forall d. Data d => d -> u) -> Tagged tag a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Tagged tag a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Tagged tag a -> m (Tagged tag a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Tagged tag a -> m (Tagged tag a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Tagged tag a -> m (Tagged tag a) #
(Ord tag, Ord a) => Ord (Tagged tag a) #
Instance details Defined in Data.EDN.AST.Types.Tagged Methods compare :: Tagged tag a -> Tagged tag a -> Ordering # (<) :: Tagged tag a -> Tagged tag a -> Bool # (<=) :: Tagged tag a -> Tagged tag a -> Bool # (>) :: Tagged tag a -> Tagged tag a -> Bool # (>=) :: Tagged tag a -> Tagged tag a -> Bool # max :: Tagged tag a -> Tagged tag a -> Tagged tag a # min :: Tagged tag a -> Tagged tag a -> Tagged tag a #
(Show tag, Show a) => Show (Tagged tag a) #
Instance details Defined in Data.EDN.AST.Types.Tagged Methods showsPrec :: Int -> Tagged tag a -> ShowS # show :: Tagged tag a -> String # showList :: [Tagged tag a] -> ShowS #
Data a => Lift (Tagged Text a) #
Instance details Defined in Data.EDN.QQ Methods lift :: Tagged Text a -> Q Exp #

stripTag :: Tagged tag a -> a #

data Value #

Constructors

Nil	nil
Boolean !Bool	true \| false
String !Text	"a string"
Character !Char	c
Symbol !Text !Text	a-prefix/a-symbol
Keyword !Text	:a-keyword
Integer !Int	42
Floating !Double	3.14
List !EDNList	(a list)
Vec !EDNVec	[a vector]
Map !EDNMap	{:a map}
Set !EDNSet	#{a set}

Instances

Eq Value #
Instance details Defined in Data.EDN.AST.Types.Value Methods (==) :: Value -> Value -> Bool # (/=) :: Value -> Value -> Bool #
Data Value #
Instance details Defined in Data.EDN.AST.Types.Value Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Value -> c Value # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Value # toConstr :: Value -> Constr # dataTypeOf :: Value -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Value) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Value) # gmapT :: (forall b. Data b => b -> b) -> Value -> Value # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r # gmapQ :: (forall d. Data d => d -> u) -> Value -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Value -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Value -> m Value # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value #
Ord Value #
Instance details Defined in Data.EDN.AST.Types.Value Methods compare :: Value -> Value -> Ordering # (<) :: Value -> Value -> Bool # (<=) :: Value -> Value -> Bool # (>) :: Value -> Value -> Bool # (>=) :: Value -> Value -> Bool # max :: Value -> Value -> Value # min :: Value -> Value -> Value #
Show Value #
Instance details Defined in Data.EDN.AST.Types.Value Methods showsPrec :: Int -> Value -> ShowS # show :: Value -> String # showList :: [Value] -> ShowS #
Lift Value #
Instance details Defined in Data.EDN.QQ Methods lift :: Value -> Q Exp #
FromEDN Value #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser Value # parseEDNv :: Value -> Parser Value #
FromEDN TaggedValue #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser TaggedValue # parseEDNv :: Value -> Parser TaggedValue #
ToEDN Value #
Instance details Defined in Data.EDN.Class Methods toEDN :: Value -> TaggedValue # toEDNv :: Value -> Value #
ToEDN TaggedValue #
Instance details Defined in Data.EDN.Class Methods toEDN :: TaggedValue -> TaggedValue # toEDNv :: TaggedValue -> Value #

type EDNList = [TaggedValue] #

type EDNVec = Vector TaggedValue #

type EDNMap = Map TaggedValue TaggedValue #

type EDNSet = Set TaggedValue #

mkList :: Foldable f => f TaggedValue -> Value #

mkVec :: Foldable f => f TaggedValue -> Value #

mkMap :: Foldable f => f (TaggedValue, TaggedValue) -> Value #

mkSet :: Foldable f => f TaggedValue -> Value #

Encoding to EDN AST

class ToEDN a where #

A type that can be converted to EDN AST.

Minimal complete definition

toEDN | toEDNv

Methods

toEDN :: a -> TaggedValue #

toEDNv :: a -> Value #

Instances

ToEDN Bool #
Instance details Defined in Data.EDN.Class Methods toEDN :: Bool -> TaggedValue # toEDNv :: Bool -> Value #
ToEDN Char #
Instance details Defined in Data.EDN.Class Methods toEDN :: Char -> TaggedValue # toEDNv :: Char -> Value #
ToEDN Double #
Instance details Defined in Data.EDN.Class Methods toEDN :: Double -> TaggedValue # toEDNv :: Double -> Value #
ToEDN Int #
Instance details Defined in Data.EDN.Class Methods toEDN :: Int -> TaggedValue # toEDNv :: Int -> Value #
ToEDN () #
Instance details Defined in Data.EDN.Class Methods toEDN :: () -> TaggedValue # toEDNv :: () -> Value #
ToEDN Void #
Instance details Defined in Data.EDN.Class Methods toEDN :: Void -> TaggedValue # toEDNv :: Void -> Value #
ToEDN Text #
Instance details Defined in Data.EDN.Class Methods toEDN :: Text -> TaggedValue # toEDNv :: Text -> Value #
ToEDN Text #
Instance details Defined in Data.EDN.Class Methods toEDN :: Text -> TaggedValue # toEDNv :: Text -> Value #
ToEDN UTCTime #
Instance details Defined in Data.EDN.Class Methods toEDN :: UTCTime -> TaggedValue # toEDNv :: UTCTime -> Value #
ToEDN UUID #
Instance details Defined in Data.EDN.Class Methods toEDN :: UUID -> TaggedValue # toEDNv :: UUID -> Value #
ToEDN Value #
Instance details Defined in Data.EDN.Class Methods toEDN :: Value -> TaggedValue # toEDNv :: Value -> Value #
ToEDN TaggedValue #
Instance details Defined in Data.EDN.Class Methods toEDN :: TaggedValue -> TaggedValue # toEDNv :: TaggedValue -> Value #
ToEDN a => ToEDN [a] #
Instance details Defined in Data.EDN.Class Methods toEDN :: [a] -> TaggedValue # toEDNv :: [a] -> Value #
ToEDN a => ToEDN (Maybe a) #
Instance details Defined in Data.EDN.Class Methods toEDN :: Maybe a -> TaggedValue # toEDNv :: Maybe a -> Value #
ToEDN a => ToEDN (Set a) #
Instance details Defined in Data.EDN.Class Methods toEDN :: Set a -> TaggedValue # toEDNv :: Set a -> Value #
ToEDN a => ToEDN (Vector a) #
Instance details Defined in Data.EDN.Class Methods toEDN :: Vector a -> TaggedValue # toEDNv :: Vector a -> Value #
(ToEDN a, ToEDN b) => ToEDN (a, b) #
Instance details Defined in Data.EDN.Class Methods toEDN :: (a, b) -> TaggedValue # toEDNv :: (a, b) -> Value #
(ToEDN k, ToEDN v) => ToEDN (Map k v) #
Instance details Defined in Data.EDN.Class Methods toEDN :: Map k v -> TaggedValue # toEDNv :: Map k v -> Value #
(ToEDN a, ToEDN b, ToEDN c) => ToEDN (a, b, c) #
Instance details Defined in Data.EDN.Class Methods toEDN :: (a, b, c) -> TaggedValue # toEDNv :: (a, b, c) -> Value #
(ToEDN a, ToEDN b, ToEDN c, ToEDN d) => ToEDN (a, b, c, d) #
Instance details Defined in Data.EDN.Class Methods toEDN :: (a, b, c, d) -> TaggedValue # toEDNv :: (a, b, c, d) -> Value #

toEDNtagged :: ToEDN a => Text -> Text -> a -> TaggedValue #

Decoding EDN AST

class FromEDN a where #

A type that can be converted from EDN, with a possibility of failure.

When writing an instance, use unexpected or fail to make a conversion fail, e.g. if an Map is missing a required key, or the value is of the wrong type.

Minimal complete definition

parseEDN | parseEDNv

Methods

parseEDN :: TaggedValue -> Parser a #

parseEDNv :: Value -> Parser a #

Instances

FromEDN Bool #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser Bool # parseEDNv :: Value -> Parser Bool #
FromEDN Char #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser Char # parseEDNv :: Value -> Parser Char #
FromEDN Double #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser Double # parseEDNv :: Value -> Parser Double #
FromEDN Int #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser Int # parseEDNv :: Value -> Parser Int #
FromEDN () #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser () # parseEDNv :: Value -> Parser () #
FromEDN Void #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser Void # parseEDNv :: Value -> Parser Void #
FromEDN Text #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser Text # parseEDNv :: Value -> Parser Text #
FromEDN Text #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser Text # parseEDNv :: Value -> Parser Text #
FromEDN UTCTime #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser UTCTime # parseEDNv :: Value -> Parser UTCTime #
FromEDN UUID #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser UUID # parseEDNv :: Value -> Parser UUID #
FromEDN Value #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser Value # parseEDNv :: Value -> Parser Value #
FromEDN TaggedValue #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser TaggedValue # parseEDNv :: Value -> Parser TaggedValue #
FromEDN a => FromEDN [a] #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser [a] # parseEDNv :: Value -> Parser [a] #
FromEDN a => FromEDN (Maybe a) #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser (Maybe a) # parseEDNv :: Value -> Parser (Maybe a) #
(FromEDN a, Ord a) => FromEDN (Set a) #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser (Set a) # parseEDNv :: Value -> Parser (Set a) #
FromEDN a => FromEDN (Vector a) #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser (Vector a) # parseEDNv :: Value -> Parser (Vector a) #
(FromEDN a, FromEDN b) => FromEDN (a, b) #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser (a, b) # parseEDNv :: Value -> Parser (a, b) #
(FromEDN k, FromEDN v, Ord k) => FromEDN (Map k v) #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser (Map k v) # parseEDNv :: Value -> Parser (Map k v) #
(FromEDN a, FromEDN b, FromEDN c) => FromEDN (a, b, c) #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser (a, b, c) # parseEDNv :: Value -> Parser (a, b, c) #
(FromEDN a, FromEDN b, FromEDN c, FromEDN d) => FromEDN (a, b, c, d) #
Instance details Defined in Data.EDN.Class Methods parseEDN :: TaggedValue -> Parser (a, b, c, d) # parseEDNv :: Value -> Parser (a, b, c, d) #