Text.Trifecta.Result

Results and Parse Errors

Parse Results

data Result a

The result of parsing. Either we succeeded or something went wrong.

Constructors

Success a

Failure Doc

Instances

Functor Result

Applicative Result

Foldable Result

Traversable Result

Alternative Result

Show a => Show (Result a)

Show a => Pretty (Result a)

AsResult (Result a) (Result b) a b

class AsResult s t a b | s -> a, t -> b, s b -> t, t a -> s where

A Prism that lets you embed or retrieve a Result in a potentially larger type.

Methods

_Result :: Prism s t (Result a) (Result b)

Instances

AsResult (Result a) (Result b) a b

_Success :: AsResult s t a b => Prism s t a b

The Prism for the Success constructor of Result

_Failure :: AsResult s s a a => Prism' s Doc

The Prism for the Failure constructor of Result

Parsing Errors

data Err

This is used to report an error. What went wrong, some supplemental docs and a set of things expected at the current location. This does not, however, include the actual location.

Constructors

Err

Fields

_reason :: Maybe Doc

_footnotes :: [Doc]

_expected :: Set String

Instances

Monoid Err

Semigroup Err

HasErr Err

class HasErr t where

Methods

err :: Lens' t Err

expected :: Lens' t (Set String)

footnotes :: Lens' t [Doc]

reason :: Lens' t (Maybe Doc)

Instances

HasErr Err

class Errable m where

Methods

raiseErr :: Err -> m a

Instances

Errable Parser

explain :: Rendering -> Err -> Doc

Convert a location and an Err into a Doc

failed :: String -> Err

Generate a simple Err word-wrapping the supplied message.