Data.EDN

Documentation

decodeText

Arguments

:: FromEDN a

=> String

Source name, for megaparsec error reports e.g. pathto/file.edn or stdin

-> Text

EDN document body

-> Either String 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

:: String

Source name, for megaparsec error reports e.g. pathto/file.edn or stdin

-> Text

EDN document body

-> Either String 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

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser TaggedValue

parseEDNv :: Value -> Parser TaggedValue

ToEDN TaggedValue

Defined in Data.EDN.Class

Methods

toEDN :: TaggedValue -> TaggedValue

toEDNv :: TaggedValue -> Value

Functor (Tagged tag)

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)

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)

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)

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)

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)

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

Defined in Data.EDN.AST.Types.Value

Methods

(==) :: Value -> Value -> Bool

(/=) :: Value -> Value -> Bool

Data Value

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

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

Defined in Data.EDN.AST.Types.Value

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

Lift Value

Defined in Data.EDN.QQ

Methods

lift :: Value -> Q Exp

FromEDN Value

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser Value

parseEDNv :: Value -> Parser Value

FromEDN TaggedValue

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser TaggedValue

parseEDNv :: Value -> Parser TaggedValue

ToEDN Value

Defined in Data.EDN.Class

Methods

toEDN :: Value -> TaggedValue

toEDNv :: Value -> Value

ToEDN TaggedValue

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

Defined in Data.EDN.Class

Methods

toEDN :: Bool -> TaggedValue

toEDNv :: Bool -> Value

ToEDN Char

Defined in Data.EDN.Class

Methods

toEDN :: Char -> TaggedValue

toEDNv :: Char -> Value

ToEDN Double

Defined in Data.EDN.Class

Methods

toEDN :: Double -> TaggedValue

toEDNv :: Double -> Value

ToEDN Int

Defined in Data.EDN.Class

Methods

toEDN :: Int -> TaggedValue

toEDNv :: Int -> Value

ToEDN ()

Defined in Data.EDN.Class

Methods

toEDN :: () -> TaggedValue

toEDNv :: () -> Value

ToEDN Void

Defined in Data.EDN.Class

Methods

toEDN :: Void -> TaggedValue

toEDNv :: Void -> Value

ToEDN Text

Defined in Data.EDN.Class

Methods

toEDN :: Text -> TaggedValue

toEDNv :: Text -> Value

ToEDN Text

Defined in Data.EDN.Class

Methods

toEDN :: Text -> TaggedValue

toEDNv :: Text -> Value

ToEDN UTCTime

Defined in Data.EDN.Class

Methods

toEDN :: UTCTime -> TaggedValue

toEDNv :: UTCTime -> Value

ToEDN UUID

Defined in Data.EDN.Class

Methods

toEDN :: UUID -> TaggedValue

toEDNv :: UUID -> Value

ToEDN Value

Defined in Data.EDN.Class

Methods

toEDN :: Value -> TaggedValue

toEDNv :: Value -> Value

ToEDN TaggedValue

Defined in Data.EDN.Class

Methods

toEDN :: TaggedValue -> TaggedValue

toEDNv :: TaggedValue -> Value

ToEDN a => ToEDN [a]

Defined in Data.EDN.Class

Methods

toEDN :: [a] -> TaggedValue

toEDNv :: [a] -> Value

ToEDN a => ToEDN (Maybe a)

Defined in Data.EDN.Class

Methods

toEDN :: Maybe a -> TaggedValue

toEDNv :: Maybe a -> Value

ToEDN a => ToEDN (Set a)

Defined in Data.EDN.Class

Methods

toEDN :: Set a -> TaggedValue

toEDNv :: Set a -> Value

ToEDN a => ToEDN (Vector a)

Defined in Data.EDN.Class

Methods

toEDN :: Vector a -> TaggedValue

toEDNv :: Vector a -> Value

(ToEDN a, ToEDN b) => ToEDN (a, b)

Defined in Data.EDN.Class

Methods

toEDN :: (a, b) -> TaggedValue

toEDNv :: (a, b) -> Value

(ToEDN k, ToEDN v) => ToEDN (Map k v)

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)

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)

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

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser Bool

parseEDNv :: Value -> Parser Bool

FromEDN Char

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser Char

parseEDNv :: Value -> Parser Char

FromEDN Double

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser Double

parseEDNv :: Value -> Parser Double

FromEDN Int

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser Int

parseEDNv :: Value -> Parser Int

FromEDN ()

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser ()

parseEDNv :: Value -> Parser ()

FromEDN Void

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser Void

parseEDNv :: Value -> Parser Void

FromEDN Text

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser Text

parseEDNv :: Value -> Parser Text

FromEDN Text

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser Text

parseEDNv :: Value -> Parser Text

FromEDN UTCTime

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser UTCTime

parseEDNv :: Value -> Parser UTCTime

FromEDN UUID

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser UUID

parseEDNv :: Value -> Parser UUID

FromEDN Value

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser Value

parseEDNv :: Value -> Parser Value

FromEDN TaggedValue

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser TaggedValue

parseEDNv :: Value -> Parser TaggedValue

FromEDN a => FromEDN [a]

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser [a]

parseEDNv :: Value -> Parser [a]

FromEDN a => FromEDN (Maybe a)

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser (Maybe a)

parseEDNv :: Value -> Parser (Maybe a)

(FromEDN a, Ord a) => FromEDN (Set a)

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser (Set a)

parseEDNv :: Value -> Parser (Set a)

FromEDN a => FromEDN (Vector a)

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser (Vector a)

parseEDNv :: Value -> Parser (Vector a)

(FromEDN a, FromEDN b) => FromEDN (a, b)

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)

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)

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)

Defined in Data.EDN.Class

Methods

parseEDN :: TaggedValue -> Parser (a, b, c, d)

parseEDNv :: Value -> Parser (a, b, c, d)

fromEDN :: FromEDN a => TaggedValue -> Either String a

Apply appropriate parsers for a value to decode AST.

AST-parsing wrappers

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

Report an decoding error due to unexpected AST node given. The Parser combines and reports alternatives expected.

Additional helpers

vecGet

Arguments

:: FromEDN a

=> Int

Element index

-> EDNVec

Vector of EDN values

-> Parser a

Get ix-th element of EDNVec or fail with appropriate message.

mapGetKeyword :: FromEDN a => Text -> EDNMap -> Parser a

Get a value from EDNMap for a Keyword key.

mapGetString :: FromEDN a => Text -> EDNMap -> Parser a

Get a value from EDNMap for a String key.

mapGetSymbol :: FromEDN a => Text -> EDNMap -> Parser a

Get a value from EDNMap for a Symbol (empty namespace) key.

mapGetSymbolNS

Arguments

:: FromEDN a

=> Text

Symbol namespace

-> Text

Symbol name

-> EDNMap

-> Parser a

Get a value from EDNMap for a Symbol (empty namespace) key.