Text.ValveVKV

Documentation

parseValveVKV :: ValveVKV a => String -> Either String a

The main function you will be using. Turns the ValveVKV string into a type that has the ValveVKV typeclass.

parseToVKV :: String -> Either ParseError [ValveKeyValueEntry]

Parses it directly to a list of entries. Most of the times, parseValveVKV will be better to directly turn it into a Haskell type of your choice

Since: 1.0.1.0

fromValveVKV :: ValveVKV a => ValveKeyValueEntry -> Context -> Either String a

The first argument is the entry that should be turned into the type. The second argument is the entry just above that.

(.:) :: ValveVKV a => ValveKeyValueEntry -> String -> Either String a infixl 5

This operator receives an entry on the left side and a string on the right side. It tries to find the subentry named the string inside the entry you gave in on the left.

(^:) :: ValveKeyValueEntry -> String -> Maybe String infixl 5

This operator receives an entry on the left side and a string on the right side. It tries to find the string subentry named the string inside the entry you gave in on the left.

class ValveVKV a

The class that lets a value to be made from a Valve value-keyvalue format. For example, if you have data My = My {name :: String, count :: Int} You write your instance as instance ValveVKV My where fromValveVKV this _ = My <$> this ^: "name" <*> this .: "count"

Minimal complete definition

fromValveVKV

Instances

ValveVKV Bool

Defined in Text.ValveVKV.Class

Methods

fromValveVKV :: ValveKeyValueEntry -> Context -> Either String Bool

ValveVKV Int

Defined in Text.ValveVKV.Class

Methods

fromValveVKV :: ValveKeyValueEntry -> Context -> Either String Int

ValveVKV a => ValveVKV [a]

Defined in Text.ValveVKV.Class

Methods

fromValveVKV :: ValveKeyValueEntry -> Context -> Either String [a]

ValveVKV a => ValveVKV (Maybe a)

Defined in Text.ValveVKV.Class

Methods

fromValveVKV :: ValveKeyValueEntry -> Context -> Either String (Maybe a)

ValveVKV a => ValveVKV (NonEmpty a)

Defined in Text.ValveVKV.Class

Methods

fromValveVKV :: ValveKeyValueEntry -> Context -> Either String (NonEmpty a)

data ValveKeyValueEntry

Constructors

KVObject (Pair [ValveKeyValueEntry])

KVString (Pair String)

KVInt (Pair Int)

Instances

Show ValveKeyValueEntry

Defined in Text.ValveVKV.Internal

Methods

showsPrec :: Int -> ValveKeyValueEntry -> ShowS

show :: ValveKeyValueEntry -> String

showList :: [ValveKeyValueEntry] -> ShowS

data Pair a

Constructors

Pair String a

Instances

Show a => Show (Pair a)

Defined in Text.ValveVKV.Internal

Methods

showsPrec :: Int -> Pair a -> ShowS

show :: Pair a -> String

showList :: [Pair a] -> ShowS

unpair :: Pair a -> (String, a)

type Context = ValveKeyValueEntry

A type synonim for ValveKeyValueEntry

vkvParser :: Parsec String () [ValveKeyValueEntry]

The Parsec parser itself.