YamlUnscrambler

Execution

parseText :: Value a -> Text -> Either Text a

parseByteString :: Value a -> ByteString -> Either Text a

getExpectations :: Value a -> Value

Get a tree of expectations, which can then be converted into documentation for people working with the YAML document or into one of the spec formats (e.g., YAML Spec, JSON Spec).

DSL

Value

data Value a

Instances

Functor Value

Defined in YamlUnscrambler

Methods

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

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

value :: [Scalar a] -> Maybe (Mapping a) -> Maybe (Sequence a) -> Value a

nullableValue :: [Scalar a] -> Maybe (Mapping a) -> Maybe (Sequence a) -> Value (Maybe a)

Helpers

sequenceValue :: Sequence a -> Value a

mappingValue :: Mapping a -> Value a

scalarsValue :: [Scalar a] -> Value a

Scalar

data Scalar a

Instances

Functor Scalar

Defined in YamlUnscrambler

Methods

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

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

stringScalar :: String a -> Scalar a

nullScalar :: a -> Scalar a

boolScalar :: Scalar Bool

scientificScalar :: Scalar Scientific

doubleScalar :: Scalar Double

rationalScalar :: MaxInputSize -> Scalar Rational

boundedIntegerScalar :: (Integral a, FiniteBits a) => Signed -> NumeralSystem -> Scalar a

E.g., Int, Int64, Word, but not Integer.

unboundedIntegerScalar :: MaxInputSize -> Signed -> NumeralSystem -> Scalar Integer

timestampScalar :: Scalar UTCTime

dayScalar :: Scalar Day

timeScalar :: Scalar TimeOfDay

uuidScalar :: Scalar UUID

binaryScalar :: Scalar ByteString

Mapping

data Mapping a

Instances

Functor Mapping

Defined in YamlUnscrambler

Methods

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

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

foldMapping :: (key -> val -> assoc) -> Fold assoc a -> String key -> Value val -> Mapping a

byKeyMapping :: CaseSensitive -> ByKey Text a -> Mapping a

Sequence

data Sequence a

Instances

Functor Sequence

Defined in YamlUnscrambler

Methods

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

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

foldSequence :: Fold a b -> Value a -> Sequence b

byOrderSequence :: ByOrder a -> Sequence a

byKeySequence :: ByKey Int a -> Sequence a

String

data String a

Instances

Functor String

Defined in YamlUnscrambler

Methods

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

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

textString :: String Text

enumString :: CaseSensitive -> [(Text, a)] -> String a

formattedString :: Text -> (Text -> Either Text a) -> String a

attoparsedString :: Text -> Parser a -> String a

ByKey

data ByKey key a

Instances

Functor (ByKey key)

Defined in YamlUnscrambler

Methods

fmap :: (a -> b) -> ByKey key a -> ByKey key b

(<$) :: a -> ByKey key b -> ByKey key a

Applicative (ByKey key)

Defined in YamlUnscrambler

Methods

pure :: a -> ByKey key a

(<*>) :: ByKey key (a -> b) -> ByKey key a -> ByKey key b

liftA2 :: (a -> b -> c) -> ByKey key a -> ByKey key b -> ByKey key c

(*>) :: ByKey key a -> ByKey key b -> ByKey key b

(<*) :: ByKey key a -> ByKey key b -> ByKey key a

Alternative (ByKey key)

Defined in YamlUnscrambler

Methods

empty :: ByKey key a

(<|>) :: ByKey key a -> ByKey key a -> ByKey key a

some :: ByKey key a -> ByKey key [a]

many :: ByKey key a -> ByKey key [a]

Selective (ByKey key)

Defined in YamlUnscrambler

Methods

select :: ByKey key (Either a b) -> ByKey key (a -> b) -> ByKey key b

atByKey :: key -> Value a -> ByKey key a

atOneOfByKey :: [key] -> Value a -> ByKey key a

ByOrder

data ByOrder a

Instances

Functor ByOrder

Defined in YamlUnscrambler

Methods

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

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

Applicative ByOrder

Defined in YamlUnscrambler

Methods

pure :: a -> ByOrder a

(<*>) :: ByOrder (a -> b) -> ByOrder a -> ByOrder b

liftA2 :: (a -> b -> c) -> ByOrder a -> ByOrder b -> ByOrder c

(*>) :: ByOrder a -> ByOrder b -> ByOrder b

(<*) :: ByOrder a -> ByOrder b -> ByOrder a

Selective ByOrder

Defined in YamlUnscrambler

Methods

select :: ByOrder (Either a b) -> ByOrder (a -> b) -> ByOrder b

fetchByOrder :: Value a -> ByOrder a

Value types

newtype MaxInputSize

Specification of the maximum allowed length for the input. A safety measure to ensure that the parser doesn't exhaust memory when parsing to unlimited datatypes.

Constructors

MaxInputSize Int

newtype Signed

Constructors

Signed Bool

data NumeralSystem

Constructors

DecimalNumeralSystem

HexadecimalNumeralSystem

newtype CaseSensitive

Constructors

CaseSensitive Bool