Prosidy.Parse

Parsing Prosidy types from Text

parseDocument :: FilePath -> Text -> Either Failure Document

Parses a Prosidy Document from its source.

The FilePath parameter is only used for error reporting.

parseDocumentMetadata :: FilePath -> Text -> Either Failure Metadata

Parses a Prosidy document's header Metadata from source, stopping when the header ends.

The FilePath parameter is only used for error reporting.

Reading & parsing Prosidy files

readDocument :: FilePath -> IO Document

Reads a Prosidy Document from the given FilePath.

Errors will be thrown as exceptions. Use parseDocument for a pure implementation.

readDocumentMetadata :: FilePath -> IO Metadata

Reads a Prosidy document's Metadata header from the given FilePath.

Errors will be thrown as exceptions. Use parseDocumentMetadata for a pure implementation.

Errors

newtype Failure

A parsing error.

Constructors

Failure (ParseErrorBundle Text Void)

Instances

Show Failure

Defined in Prosidy.Parse

Methods

showsPrec :: Int -> Failure -> ShowS

show :: Failure -> String

showList :: [Failure] -> ShowS

Exception Failure

Defined in Prosidy.Parse

Methods

toException :: Failure -> SomeException

fromException :: SomeException -> Maybe Failure

displayException :: Failure -> String

prettyFailure :: Failure -> String

Pretty-print a Failure into a message acceptable for displaying to users.