Modulepandoc-3.12

Text.Pandoc.Class

Synopsis

value extractMedia
value runIO
value runIOorExplode
value checkUserDataDir
value extractURIData
value fetchItem
value fillMediaBag
value findFileWithDataFallback
value getInputFiles
value getLog
value getMediaBag
value getOutputFile
value getPOSIXTime
value getRequestHeaders
value getResourcePath
value getSourceURL
value getTimestamp
value getTrace
value getUserDataDir
value getVerbosity
value getZonedTime
value insertMedia
value readFileFromDirs
value readMetadataFile
value report
value runSilently
value setInputFiles
value setMediaBag
value setNoCheckCertificate
value setOutputFile
value setRequestHeader
value setRequestHeaders
value setResourcePath
value setTrace
value setUserDataDir
value setVerbosity
value toLang
value toTextM
value addToFileTree
value getPureState
value getsPureState
value insertInFileTree
value modifyPureState
value putPureState
value runPure
value sandbox
value sandboxWithFileTree
value makeCanonical
data CommonState
newtype PandocIO
class PandocMonad
data FileInfo
newtype FileTree
newtype PandocPure
data PureState
newtype Translations

Packagepandoc-3.12
Exports56
LicenceGPL-2.0-or-later

valueextractMedia :: (PandocMonad m, MonadIO m) => FilePath -> Pandoc -> m Pandoc

valuerunIO :: PandocIO a -> IO (Either PandocError a)

valuerunIOorExplode :: PandocIO a -> IO a

valuecheckUserDataDir :: PandocMonad m => FilePath -> m (Maybe FilePath)

valueextractURIData :: String -> (ByteString, Maybe MimeType)

valuefetchItem :: PandocMonad m => Text -> m (ByteString, Maybe MimeType)

valuefillMediaBag :: PandocMonad m => Pandoc -> m Pandoc

valuefindFileWithDataFallback

:: PandocMonad m
=> FilePath
-> FilePath
-> m (Maybe FilePath)

valuegetInputFiles :: PandocMonad m => m [FilePath]

valuegetLog :: PandocMonad m => m [LogMessage]

valuegetMediaBag :: PandocMonad m => m MediaBag

valuegetOutputFile :: PandocMonad m => m (Maybe FilePath)

valuegetPOSIXTime :: PandocMonad m => m POSIXTime

valuegetRequestHeaders :: PandocMonad m => m [(Text, Text)]

valuegetResourcePath :: PandocMonad m => m [FilePath]

valuegetSourceURL :: PandocMonad m => m (Maybe Text)

valuegetTimestamp :: PandocMonad m => m UTCTime

valuegetTrace :: PandocMonad m => m Bool

valuegetUserDataDir :: PandocMonad m => m (Maybe FilePath)

valuegetVerbosity :: PandocMonad m => m Verbosity

valuegetZonedTime :: PandocMonad m => m ZonedTime

valueinsertMedia

:: PandocMonad m
=> FilePath
-> Maybe MimeType
-> ByteString
-> m ()

valuereadFileFromDirs

:: PandocMonad m
=> [FilePath]
-> FilePath
-> m (Maybe Text)

valuereadMetadataFile :: PandocMonad m => FilePath -> m ByteString

valuereport :: PandocMonad m => LogMessage -> m ()

valuerunSilently :: PandocMonad m => m a -> m (a, [LogMessage])

valuesetInputFiles :: PandocMonad m => [FilePath] -> m ()

valuesetMediaBag :: PandocMonad m => MediaBag -> m ()

valuesetNoCheckCertificate :: PandocMonad m => Bool -> m ()

valuesetOutputFile :: PandocMonad m => Maybe FilePath -> m ()

valuesetRequestHeader :: PandocMonad m => Text -> Text -> m ()

valuesetRequestHeaders :: PandocMonad m => [(Text, Text)] -> m ()

valuesetResourcePath :: PandocMonad m => [FilePath] -> m ()

valuesetTrace :: PandocMonad m => Bool -> m ()

valuesetUserDataDir :: PandocMonad m => Maybe FilePath -> m ()

valuesetVerbosity :: PandocMonad m => Verbosity -> m ()

valuetoLang :: PandocMonad m => Maybe Text -> m (Maybe Lang)

valuetoTextM :: PandocMonad m => FilePath -> ByteString -> m Text

valueaddToFileTree :: FileTree -> FilePath -> IO FileTree

valuegetPureState :: PandocPure PureState

valuegetsPureState :: (PureState -> a) -> PandocPure a

valueinsertInFileTree :: FilePath -> FileInfo -> FileTree -> FileTree

valuemodifyPureState :: (PureState -> PureState) -> PandocPure ()

valueputPureState :: PureState -> PandocPure ()

valuerunPure :: PandocPure a -> Either PandocError a

valuesandbox :: (PandocMonad m, MonadIO m) => [FilePath] -> PandocPure a -> m a

valuesandboxWithFileTree

:: (PandocMonad m, MonadIO m)
=> FileTree
-> PandocPure a
-> m a

valuemakeCanonical :: FilePath -> FilePath

datadata CommonState

Instances1Default

Default CommonStateDefined in pandoc-3.12 · Text.Pandoc.Class.CommonState

newtypenewtype PandocIO a

Constructors

PandocIO
- unPandocIO :: ExceptT PandocError (StateT CommonState IO) a

Instances9Monad, Functor, Applicative, MonadIO, MonadCatch, MonadMask, …

Monad PandocIODefined in pandoc-3.12 · Text.Pandoc.Class.PandocIO
Functor PandocIODefined in pandoc-3.12 · Text.Pandoc.Class.PandocIO
Applicative PandocIODefined in pandoc-3.12 · Text.Pandoc.Class.PandocIO
MonadIO PandocIODefined in pandoc-3.12 · Text.Pandoc.Class.PandocIO
MonadCatch PandocIODefined in pandoc-3.12 · Text.Pandoc.Class.PandocIO
MonadMask PandocIODefined in pandoc-3.12 · Text.Pandoc.Class.PandocIO
MonadThrow PandocIODefined in pandoc-3.12 · Text.Pandoc.Class.PandocIO
PandocMonad PandocIODefined in pandoc-3.12 · Text.Pandoc.Class.PandocIO
MonadError PandocError PandocIODefined in pandoc-3.12 · Text.Pandoc.Class.PandocIO

classclass (Functor m, Applicative m, Monad m, MonadError PandocError m) => PandocMonad (m :: Type -> Type) where

Methods

lookupEnv :: Text -> m (Maybe Text)
getCurrentTime :: m UTCTime
getCurrentTimeZone :: m TimeZone
newStdGen :: m StdGen
newUniqueHash :: m Int
openURL :: Text -> m (ByteString, Maybe MimeType)
readFileLazy :: FilePath -> m ByteString
readFileStrict :: FilePath -> m ByteString
readStdinStrict :: m ByteString
glob :: String -> m [FilePath]
fileExists :: FilePath -> m Bool
getDataFileName :: FilePath -> m FilePath
getModificationTime :: FilePath -> m UTCTime
getCommonState :: m CommonState
putCommonState :: CommonState -> m ()
getsCommonState :: (CommonState -> a) -> m a
modifyCommonState :: (CommonState -> CommonState) -> m ()
logOutput :: LogMessage -> m ()
trace :: Text -> m ()

Instances4PandocMonad

PandocMonad PandocIODefined in pandoc-3.12 · Text.Pandoc.Class.PandocIO
PandocMonad PandocPureDefined in pandoc-3.12 · Text.Pandoc.Class.PandocPure
(MonadTrans t, PandocMonad m, Functor (t m), MonadError PandocError (t m), Monad (t m), Applicative (t m)) => PandocMonad (t m)Defined in pandoc-3.12 · Text.Pandoc.Class.PandocMonad
PandocMonad m => PandocMonad (ParsecT s st m)Defined in pandoc-3.12 · Text.Pandoc.Class.PandocMonad

datadata FileInfo

Constructors

FileInfo
- infoFileMTime :: UTCTime
- infoFileContents :: ByteString

newtypenewtype FileTree

Instances2Semigroup, Monoid

Semigroup FileTreeDefined in pandoc-3.12 · Text.Pandoc.Class.PandocPure
Monoid FileTreeDefined in pandoc-3.12 · Text.Pandoc.Class.PandocPure

newtypenewtype PandocPure a

Constructors

PandocPure
- unPandocPure :: ExceptT PandocError (StateT CommonState (State PureState)) a

Instances5Monad, Functor, Applicative, PandocMonad, MonadError

Monad PandocPureDefined in pandoc-3.12 · Text.Pandoc.Class.PandocPure
Functor PandocPureDefined in pandoc-3.12 · Text.Pandoc.Class.PandocPure
Applicative PandocPureDefined in pandoc-3.12 · Text.Pandoc.Class.PandocPure
PandocMonad PandocPureDefined in pandoc-3.12 · Text.Pandoc.Class.PandocPure
MonadError PandocError PandocPureDefined in pandoc-3.12 · Text.Pandoc.Class.PandocPure

datadata PureState

Constructors

PureState
- stStdGen :: StdGen
- stWord8Store :: [Word8]
- stUniqStore :: [Int]
- stEnv :: [(Text, Text)]
- stTime :: UTCTime
- stTimeZone :: TimeZone
- stReferenceDocx :: Archive
- stReferencePptx :: Archive
- stReferenceODT :: Archive
- stFiles :: FileTree
- stStdin :: ByteString
- stUserDataFiles :: FileTree
- stCabalDataFiles :: FileTree

Instances1Default

Default PureStateDefined in pandoc-3.12 · Text.Pandoc.Class.PandocPure

newtypenewtype Translations

Instances6Show, Generic, Semigroup, Monoid, FromJSON, Rep

Show TranslationsDefined in pandoc-3.12 · Text.Pandoc.Translations.Types
Generic TranslationsDefined in pandoc-3.12 · Text.Pandoc.Translations.Types
Semigroup TranslationsDefined in pandoc-3.12 · Text.Pandoc.Translations.Types
Monoid TranslationsDefined in pandoc-3.12 · Text.Pandoc.Translations.Types
FromJSON TranslationsDefined in pandoc-3.12 · Text.Pandoc.Translations.Types
type Rep Translations = D1 ('MetaData "Translations" "Text.Pandoc.Translations.Types" "pandoc-3.12-9FnALslKhKND1JbvkOs22J" 'True) (C1 ('MetaCons "Translations" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Term Text))))Defined in pandoc-3.12 · Text.Pandoc.Translations.Types