Waargonaut.Types.Whitespace

Parsers and builders for whitespace characters in our JSON.

Documentation

data Whitespace

Represent the different types of whitespace.

Constructors

Space

HorizontalTab

LineFeed

NewLine

CarriageReturn

Instances

Eq Whitespace

Defined in Waargonaut.Types.Whitespace

Methods

(==) :: Whitespace -> Whitespace -> Bool

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

Ord Whitespace

Defined in Waargonaut.Types.Whitespace

Methods

compare :: Whitespace -> Whitespace -> Ordering

(<) :: Whitespace -> Whitespace -> Bool

(<=) :: Whitespace -> Whitespace -> Bool

(>) :: Whitespace -> Whitespace -> Bool

(>=) :: Whitespace -> Whitespace -> Bool

max :: Whitespace -> Whitespace -> Whitespace

min :: Whitespace -> Whitespace -> Whitespace

Show Whitespace

Defined in Waargonaut.Types.Whitespace

Methods

showsPrec :: Int -> Whitespace -> ShowS

show :: Whitespace -> String

showList :: [Whitespace] -> ShowS

Cons WS WS Whitespace Whitespace

Defined in Waargonaut.Types.Whitespace

Methods

_Cons :: Prism WS WS (Whitespace, WS) (Whitespace, WS)

newtype WS

This is a wrapper for a sequence of consecutive whitespace.

Constructors

WS (Vector Whitespace)

Instances

Eq WS

Defined in Waargonaut.Types.Whitespace

Methods

(==) :: WS -> WS -> Bool

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

Show WS

Defined in Waargonaut.Types.Whitespace

Methods

showsPrec :: Int -> WS -> ShowS

show :: WS -> String

showList :: [WS] -> ShowS

Semigroup WS

Defined in Waargonaut.Types.Whitespace

Methods

(<>) :: WS -> WS -> WS

sconcat :: NonEmpty WS -> WS

stimes :: Integral b => b -> WS -> WS

Monoid WS

Defined in Waargonaut.Types.Whitespace

Methods

mempty :: WS

mappend :: WS -> WS -> WS

mconcat :: [WS] -> WS

Wrapped WS

Defined in Waargonaut.Types.Whitespace

Associated Types

type Unwrapped WS :: Type

Methods

_Wrapped' :: Iso' WS (Unwrapped WS)

AsEmpty WS

Defined in Waargonaut.Types.Whitespace

Methods

_Empty :: Prism' WS ()

WS ~ t => Rewrapped WS t

Defined in Waargonaut.Types.Whitespace

AsJType Json WS Json

Json is comprised of the different JType types.

Defined in Waargonaut.Types.Json

Methods

_JType :: Prism' Json (JType WS Json)

_JNull :: Prism' Json WS

_JBool :: Prism' Json (Bool, WS)

_JNum :: Prism' Json (JNumber, WS)

_JStr :: Prism' Json (JString, WS)

_JArr :: Prism' Json (JArray WS Json, WS)

_JObj :: Prism' Json (JObject WS Json, WS)

Cons WS WS Whitespace Whitespace

Defined in Waargonaut.Types.Whitespace

Methods

_Cons :: Prism WS WS (Whitespace, WS) (Whitespace, WS)

type Unwrapped WS

Defined in Waargonaut.Types.Whitespace

type Unwrapped WS = Vector Whitespace

_WhitespaceChar :: Prism' Char Whitespace

Handy Prism' between a Char its possible Whitespace representation.

escapedWhitespaceChar :: Whitespace -> Char

Change a Whitespace into its escaped Char form.

unescapedWhitespaceChar :: Whitespace -> Char

Change a Whitespace into a single unescaped Char. Useful if you're already handling escaping with some other mechanism.

oneWhitespace :: CharParsing f => f Whitespace

Parse a single Whitespace character.

parseWhitespace :: CharParsing f => f WS

>>> testparse parseWhitespace " "
Right (WS [Space])

>>> testparse parseWhitespace "\n    "
Right (WS [NewLine,Space,Space,Space,Space])

>>> testparse parseWhitespace " \t"
Right (WS [Space,HorizontalTab])

>>> testparse parseWhitespace "\f\f"
Right (WS [LineFeed,LineFeed])

>>> testparse parseWhitespace "\r\r\r"
Right (WS [CarriageReturn,CarriageReturn,CarriageReturn])

>>> testparse parseWhitespace "\n\r\r\n"
Right (WS [NewLine,CarriageReturn,CarriageReturn,NewLine])

>>> testparse parseWhitespace ""
Right (WS [])

>>> testparse parseWhitespace "\n   ]"
Right (WS [NewLine,Space,Space,Space])

parseSomeWhitespace :: CharParsing f => f (NonEmpty Whitespace)

Parse a NonEmpty sequence of consecutive whitespace.

wsBuilder :: WS -> Builder

Reconstitute the given whitespace into its original form.

wsRemover :: WS -> Builder

Remove any whitespace. Minification for free, yay!