Data.EDN

Encoding and decoding

decode :: FromEDN a => ByteString -> Maybe a

Deserializes a EDN value from a lazy ByteString. If this fails to to incomplete or invalid input, Nothing is returned.

encode :: ToEDN a => a -> ByteString

Serialize a value as a lazy ByteString.

Core EDN types

data Value

A "raw" EDN value represented as a Haskell value.

Constructors

Nil

Boolean !Bool

String !Text

Character !Char

Symbol !ByteString !ByteString

Keyword !ByteString

Integer !Integer

Floating !Double

List EDNList

Vec !EDNVec

Map !EDNMap

Set !EDNSet

Instances

Eq Value

Methods

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

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

Ord 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

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

IsString Value

Strings starting with ":" will become keywords.

Methods

fromString :: String -> Value

NFData Value

Methods

rnf :: Value -> ()

FromEDN Value

Methods

parseEDN :: TaggedValue -> Parser Value

parseEDNv :: Value -> Parser Value

FromEDN TaggedValue

Methods

parseEDN :: TaggedValue -> Parser TaggedValue

parseEDNv :: Value -> Parser TaggedValue

ToEDN Value

Methods

toEDN :: Value -> TaggedValue

toEDNv :: Value -> Value

ToEDN TaggedValue

Methods

toEDN :: TaggedValue -> TaggedValue

toEDNv :: TaggedValue -> Value

IsString (Tagged Value)

Strings will become an tagless EDN strings.

Methods

fromString :: String -> Tagged Value

type TaggedValue = Tagged Value

data Tagged a

Abstract namespaced tag.

Constructors

NoTag !a

Tagged !a !ByteString !ByteString

Instances

Functor Tagged

Methods

fmap :: (a -> b) -> Tagged a -> Tagged b

(<$) :: a -> Tagged b -> Tagged a

FromEDN TaggedValue

Methods

parseEDN :: TaggedValue -> Parser TaggedValue

parseEDNv :: Value -> Parser TaggedValue

ToEDN TaggedValue

Methods

toEDN :: TaggedValue -> TaggedValue

toEDNv :: TaggedValue -> Value

Eq a => Eq (Tagged a)

Methods

(==) :: Tagged a -> Tagged a -> Bool

(/=) :: Tagged a -> Tagged a -> Bool

Ord a => Ord (Tagged a)

Methods

compare :: Tagged a -> Tagged a -> Ordering

(<) :: Tagged a -> Tagged a -> Bool

(<=) :: Tagged a -> Tagged a -> Bool

(>) :: Tagged a -> Tagged a -> Bool

(>=) :: Tagged a -> Tagged a -> Bool

max :: Tagged a -> Tagged a -> Tagged a

min :: Tagged a -> Tagged a -> Tagged a

Show a => Show (Tagged a)

Methods

showsPrec :: Int -> Tagged a -> ShowS

show :: Tagged a -> String

showList :: [Tagged a] -> ShowS

IsString (Tagged Value)

Strings will become an tagless EDN strings.

Methods

fromString :: String -> Tagged Value

NFData a => NFData (Tagged a)

Methods

rnf :: Tagged a -> ()

FromEDN a => FromEDN (Tagged a)

Methods

parseEDN :: TaggedValue -> Parser (Tagged a)

parseEDNv :: Value -> Parser (Tagged a)

ToEDN a => ToEDN (Tagged a)

Methods

toEDN :: Tagged a -> TaggedValue

toEDNv :: Tagged a -> Value

Type conversion

class ToEDN a where

A type that can be converted to JSON.

Methods

toEDN :: a -> TaggedValue

Instances

ToEDN Bool

Methods

toEDN :: Bool -> TaggedValue

toEDNv :: Bool -> Value

ToEDN Char

Methods

toEDN :: Char -> TaggedValue

toEDNv :: Char -> Value

ToEDN Double

Methods

toEDN :: Double -> TaggedValue

toEDNv :: Double -> Value

ToEDN Int

Methods

toEDN :: Int -> TaggedValue

toEDNv :: Int -> Value

ToEDN Integer

Methods

toEDN :: Integer -> TaggedValue

toEDNv :: Integer -> Value

ToEDN ()

Methods

toEDN :: () -> TaggedValue

toEDNv :: () -> Value

ToEDN ByteString

Methods

toEDN :: ByteString -> TaggedValue

toEDNv :: ByteString -> Value

ToEDN ByteString

Methods

toEDN :: ByteString -> TaggedValue

toEDNv :: ByteString -> Value

ToEDN Text

Methods

toEDN :: Text -> TaggedValue

toEDNv :: Text -> Value

ToEDN Text

Methods

toEDN :: Text -> TaggedValue

toEDNv :: Text -> Value

ToEDN UTCTime

Methods

toEDN :: UTCTime -> TaggedValue

toEDNv :: UTCTime -> Value

ToEDN Value

Methods

toEDN :: Value -> TaggedValue

toEDNv :: Value -> Value

ToEDN TaggedValue

Methods

toEDN :: TaggedValue -> TaggedValue

toEDNv :: TaggedValue -> Value

ToEDN [Char]

Methods

toEDN :: [Char] -> TaggedValue

toEDNv :: [Char] -> Value

ToEDN a => ToEDN [a]

Methods

toEDN :: [a] -> TaggedValue

toEDNv :: [a] -> Value

ToEDN a => ToEDN (Maybe a)

Methods

toEDN :: Maybe a -> TaggedValue

toEDNv :: Maybe a -> Value

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

Methods

toEDN :: Set a -> TaggedValue

toEDNv :: Set a -> Value

ToEDN a => ToEDN (Vector a)

Methods

toEDN :: Vector a -> TaggedValue

toEDNv :: Vector a -> Value

ToEDN a => ToEDN (Tagged a)

Methods

toEDN :: Tagged a -> TaggedValue

toEDNv :: Tagged a -> Value

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

Methods

toEDN :: Either a b -> TaggedValue

toEDNv :: Either a b -> Value

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

Methods

toEDN :: (a, b) -> TaggedValue

toEDNv :: (a, b) -> Value

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

Methods

toEDN :: Map a b -> TaggedValue

toEDNv :: Map a b -> Value

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

Methods

toEDN :: (a, b, c) -> TaggedValue

toEDNv :: (a, b, c) -> Value

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

Methods

toEDN :: (a, b, c, d) -> TaggedValue

toEDNv :: (a, b, c, d) -> Value

(ToEDN a, ToEDN b, ToEDN c, ToEDN d, ToEDN e) => ToEDN (a, b, c, d, e)

Methods

toEDN :: (a, b, c, d, e) -> TaggedValue

toEDNv :: (a, b, c, d, e) -> Value

(ToEDN a, ToEDN b, ToEDN c, ToEDN d, ToEDN e, ToEDN f) => ToEDN (a, b, c, d, e, f)

Methods

toEDN :: (a, b, c, d, e, f) -> TaggedValue

toEDNv :: (a, b, c, d, e, f) -> Value

(ToEDN a, ToEDN b, ToEDN c, ToEDN d, ToEDN e, ToEDN f, ToEDN g) => ToEDN (a, b, c, d, e, f, g)

Methods

toEDN :: (a, b, c, d, e, f, g) -> TaggedValue

toEDNv :: (a, b, c, d, e, f, g) -> Value

(ToEDN a, ToEDN b, ToEDN c, ToEDN d, ToEDN e, ToEDN f, ToEDN g, ToEDN h) => ToEDN (a, b, c, d, e, f, g, h)

Methods

toEDN :: (a, b, c, d, e, f, g, h) -> TaggedValue

toEDNv :: (a, b, c, d, e, f, g, h) -> Value

class FromEDN a

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

When writing an instance, use empty, mzero, 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.

Instances

FromEDN Bool

Methods

parseEDN :: TaggedValue -> Parser Bool

parseEDNv :: Value -> Parser Bool

FromEDN Char

Methods

parseEDN :: TaggedValue -> Parser Char

parseEDNv :: Value -> Parser Char

FromEDN Double

Methods

parseEDN :: TaggedValue -> Parser Double

parseEDNv :: Value -> Parser Double

FromEDN Int

Methods

parseEDN :: TaggedValue -> Parser Int

parseEDNv :: Value -> Parser Int

FromEDN Integer

Methods

parseEDN :: TaggedValue -> Parser Integer

parseEDNv :: Value -> Parser Integer

FromEDN ()

Methods

parseEDN :: TaggedValue -> Parser ()

parseEDNv :: Value -> Parser ()

FromEDN ByteString

Methods

parseEDN :: TaggedValue -> Parser ByteString

parseEDNv :: Value -> Parser ByteString

FromEDN ByteString

Methods

parseEDN :: TaggedValue -> Parser ByteString

parseEDNv :: Value -> Parser ByteString

FromEDN Text

Methods

parseEDN :: TaggedValue -> Parser Text

parseEDNv :: Value -> Parser Text

FromEDN Text

Methods

parseEDN :: TaggedValue -> Parser Text

parseEDNv :: Value -> Parser Text

FromEDN UTCTime

Methods

parseEDN :: TaggedValue -> Parser UTCTime

parseEDNv :: Value -> Parser UTCTime

FromEDN Value

Methods

parseEDN :: TaggedValue -> Parser Value

parseEDNv :: Value -> Parser Value

FromEDN TaggedValue

Methods

parseEDN :: TaggedValue -> Parser TaggedValue

parseEDNv :: Value -> Parser TaggedValue

FromEDN [Char]

Methods

parseEDN :: TaggedValue -> Parser [Char]

parseEDNv :: Value -> Parser [Char]

FromEDN a => FromEDN [a]

Methods

parseEDN :: TaggedValue -> Parser [a]

parseEDNv :: Value -> Parser [a]

FromEDN a => FromEDN (Maybe a)

Methods

parseEDN :: TaggedValue -> Parser (Maybe a)

parseEDNv :: Value -> Parser (Maybe a)

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

Methods

parseEDN :: TaggedValue -> Parser (Set a)

parseEDNv :: Value -> Parser (Set a)

FromEDN a => FromEDN (Vector a)

Methods

parseEDN :: TaggedValue -> Parser (Vector a)

parseEDNv :: Value -> Parser (Vector a)

FromEDN a => FromEDN (Tagged a)

Methods

parseEDN :: TaggedValue -> Parser (Tagged a)

parseEDNv :: Value -> Parser (Tagged a)

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

Methods

parseEDN :: TaggedValue -> Parser (Either a b)

parseEDNv :: Value -> Parser (Either a b)

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

Methods

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

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

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

Methods

parseEDN :: TaggedValue -> Parser (Map a b)

parseEDNv :: Value -> Parser (Map a b)

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

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)

Methods

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

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

(FromEDN a, FromEDN b, FromEDN c, FromEDN d, FromEDN e) => FromEDN (a, b, c, d, e)

Methods

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

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

(FromEDN a, FromEDN b, FromEDN c, FromEDN d, FromEDN e, FromEDN f) => FromEDN (a, b, c, d, e, f)

Methods

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

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

(FromEDN a, FromEDN b, FromEDN c, FromEDN d, FromEDN e, FromEDN f, FromEDN g) => FromEDN (a, b, c, d, e, f, g)

Methods

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

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

(FromEDN a, FromEDN b, FromEDN c, FromEDN d, FromEDN e, FromEDN f, FromEDN g, FromEDN h) => FromEDN (a, b, c, d, e, f, g, h)

Methods

parseEDN :: TaggedValue -> Parser (a, b, c, d, e, f, g, h)

parseEDNv :: Value -> Parser (a, b, c, d, e, f, g, h)

toEDN :: ToEDN a => a -> TaggedValue

fromEDN :: FromEDN a => TaggedValue -> Result a

Convert a value from TaggedValue, failing if the types do not match.

fromEDNv :: FromEDN a => Value -> Result a

Convert a value from Value, failing if the types do not match.

(.:) :: (Show k, ToEDN k, FromEDN a) => EDNMap -> k -> Parser a

Retrieve the value associated with the given key of an EDNMap. The result is empty if the key is not present or the value cannot be converted to the desired type.

This accessor is appropriate if the key and value must be present in an object for it to be valid. If the key and value are optional, use '(.:?)' instead.

(.:?) :: (ToEDN k, FromEDN a) => EDNMap -> k -> Parser (Maybe a)

Retrieve the value associated with the given key of an EDNMap. The result is Nothing if the key is not present, or empty if the value cannot be converted to the desired type.

This accessor is most useful if the key and value can be absent from an object without affecting its validity. If the key and value are mandatory, use '(.:)' instead.

(.!=) :: Parser (Maybe a) -> a -> Parser a

Helper for use in combination with .:? to provide default values for optional JSON object fields.

This combinator is most useful if the key and value can be absent from an object without affecting its validity and we know a default value to assign in that case. If the key and value are mandatory, use '(.:)' instead.

Example usage:

 v1 <- o .:? "opt_field_with_dfl" .!= "default_val"
 v2 <- o .:  "mandatory_field"
 v3 <- o .:? "opt_field2"

Constructors

tag :: ByteString -> ByteString -> a -> Tagged a

Attach a namespaced tag to a value.

notag :: a -> Tagged a

Wrap a value into tagless container.

Basic values

nil :: TaggedValue

Basic EDN nil.

bool :: Bool -> TaggedValue

Basic EDN boolean.

true :: TaggedValue

Const EDN True.

false :: TaggedValue

Const EDN False.

char :: Char -> TaggedValue

Basic EDN character.

string :: Text -> TaggedValue

Basic EDN string.

symbol :: ByteString -> TaggedValue

"Bare" symbol.

symbolNS :: ByteString -> ByteString -> TaggedValue

A namespaced symbol.

keyword :: ByteString -> TaggedValue

Basic EDN keyword.

integer :: Integer -> TaggedValue

Basic EDN integer.

floating :: Double -> TaggedValue

Basic EDN fp number.

Containers

makeList :: [TaggedValue] -> Value

Create an EDN List from a Value list wrapping them into empty tags.

makeVec :: [TaggedValue] -> Value

Create an EDN Vector from a TaggedValue list.

makeSet :: [TaggedValue] -> Value

Create an EDN Set from a TaggedValue list.

makeMap :: [Pair] -> Value

Create an EDN Map from a assoc list with untagged keys and tagged values.

type Pair = (Value, TaggedValue)

A key/value pair for a EDN Map

(.=) :: ToEDN a => ByteString -> a -> Pair

Construct a Pair from a key (as EDN keyword) and a value.

Tag manipulation

setTag :: ByteString -> ByteString -> Tagged a -> Tagged a

Replace a tag on a Tagged value.

getTag :: TaggedValue -> (ByteString, ByteString)

Extract namespace and tag from a tagged container. Will be a pair of empty for tagless containers.

stripTag :: Tagged a -> a

Extract bare value from a tagged or tagless container.

Parsing

parseMaybe :: ByteString -> Maybe TaggedValue

Parse a lazy ByteString into a TaggedValue. If fails due to incomplete or invalid input, Nothing is returned.