Data.EDN.Types

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

Ord Value

Show Value

IsString Value

Strings starting with ":" will become keywords.

NFData Value

FromEDN Value

FromEDN TaggedValue

ToEDN Value

ToEDN TaggedValue

IsString (Tagged Value)

Strings will become an tagless EDN strings.

data Tagged a

Abstract namespaced tag.

Constructors

NoTag !a

Tagged !a !ByteString !ByteString

Instances

Functor Tagged

FromEDN TaggedValue

ToEDN TaggedValue

Eq a => Eq (Tagged a)

Ord a => Ord (Tagged a)

Show a => Show (Tagged a)

IsString (Tagged Value)

Strings will become an tagless EDN strings.

NFData a => NFData (Tagged a)

FromEDN a => FromEDN (Tagged a)

ToEDN a => ToEDN (Tagged a)

type TaggedValue = Tagged Value

Internal containers

type EDNList

Arguments

 = [TaggedValue]

An EDN list (head:tail container).

type EDNVec

Arguments

 = Vector TaggedValue

An EDN vector (position-indexed container) of EDN values.

type EDNSet

Arguments

 = Set TaggedValue

An EDN set (unordered container of unique values).

type EDNMap

Arguments

 = Map Value TaggedValue

An EDN map (key/value container). Keys are untagged and values are tagged.

type Pair = (Value, TaggedValue)

A key/value pair for a EDN Map

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.

Constructors

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

Attach a namespaced tag to a value.

notag :: a -> Tagged a

Wrap a value into tagless container.

Trivial 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.