Copyright | Copyright (C) 2014 John MacFarlane |
---|---|
License | GNU GPL, version 2 or above |
Maintainer | John MacFarlane <jgm@berkeley.edu> |
Stability | alpha |
Portability | portable |
Safe Haskell | None |
Language | Haskell98 |
Text.Pandoc.MediaBag
Description
Definition of a MediaBag object to hold binary resources, and an interface for interacting with it.
- data MediaBag
- lookupMedia :: FilePath -> MediaBag -> Maybe (String, ByteString)
- insertMedia :: FilePath -> Maybe String -> ByteString -> MediaBag -> MediaBag
- mediaDirectory :: MediaBag -> [(String, String, Int)]
- extractMediaBag :: Bool -> FilePath -> MediaBag -> IO ()
Documentation
data MediaBag
lookupMedia :: FilePath -> MediaBag -> Maybe (String, ByteString)
Lookup a media item in a MediaBag
, returning mime type and contents.
Arguments
:: FilePath | relative path and canonical name of resource |
-> Maybe String | mime type (Nothing = determine from extension) |
-> ByteString | contents of resource |
-> MediaBag | |
-> MediaBag |
Insert a media item into a MediaBag
, replacing any existing
value with the same name.
mediaDirectory :: MediaBag -> [(String, String, Int)]
Get a list of the file paths stored in a MediaBag
, with
their corresponding mime types and the lengths in bytes of the contents.
extractMediaBag :: Bool -> FilePath -> MediaBag -> IO ()
Extract contents of MediaBag to a given directory. Print informational
messages if verbose
is true.