Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Synopsis
- data OrgParser a
- type OrgParseError = ParseErrorBundle Text Void
- data OrgOptions = OrgOptions {}
- type TodoSequence = [TodoKeyword]
- defaultOrgOptions :: OrgOptions
- parseOrgMaybe :: OrgOptions -> OrgParser a -> Text -> Maybe a
- parseOrg :: OrgOptions -> OrgParser a -> FilePath -> Text -> Either OrgParseError a
- parseOrgDoc :: OrgOptions -> FilePath -> Text -> Either OrgParseError OrgDocument
- parseOrgDocIO :: MonadIO m => OrgOptions -> FilePath -> m OrgDocument
Documentation
Instances
type OrgParseError = ParseErrorBundle Text Void Source #
data OrgOptions Source #
Instances
type TodoSequence = [TodoKeyword] Source #
Collection of todo markers in the order in which items should progress
parseOrgMaybe :: OrgOptions -> OrgParser a -> Text -> Maybe a Source #
Evaluate the Org Parser state with the desired options. Returns Nothing
in
case of parse failure.
parseOrg :: OrgOptions -> OrgParser a -> FilePath -> Text -> Either OrgParseError a Source #
Wrapper around parse
that evaluates the Org Parser state with the desired
options.
parseOrgDoc :: OrgOptions -> FilePath -> Text -> Either OrgParseError OrgDocument Source #
Parse an Org document fully, with given options, and a filepath for error messages.
parseOrgDocIO :: MonadIO m => OrgOptions -> FilePath -> m OrgDocument Source #
Parse an Org document in a UTF8 file, with given options.