Copyright	Copyright (C) 2014-2015 2017–2020 John MacFarlane
License	GNU GPL, version 2 or above
Maintainer	John MacFarlane <jgm@berkeley.edu>
Stability	alpha
Portability	portable
Safe Haskell	None
Language	Haskell2010

Text.Pandoc.MediaBag

Description

Definition of a MediaBag object to hold binary resources, and an interface for interacting with it.

Synopsis

data MediaBag
deleteMedia :: FilePath -> MediaBag -> MediaBag
lookupMedia :: FilePath -> MediaBag -> Maybe (MimeType, ByteString)
insertMedia :: FilePath -> Maybe MimeType -> ByteString -> MediaBag -> MediaBag
mediaDirectory :: MediaBag -> [(FilePath, MimeType, Int)]
mediaItems :: MediaBag -> [(FilePath, MimeType, ByteString)]

Documentation

data MediaBag Source #

A container for a collection of binary resources, with names and mime types. Note that a MediaBag is a Monoid, so mempty can be used for an empty MediaBag, and <> can be used to append two MediaBags.

Instances

Data MediaBag Source #
Instance details Defined in Text.Pandoc.MediaBag Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MediaBag -> c MediaBag # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MediaBag # toConstr :: MediaBag -> Constr # dataTypeOf :: MediaBag -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MediaBag) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MediaBag) # gmapT :: (forall b. Data b => b -> b) -> MediaBag -> MediaBag # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MediaBag -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MediaBag -> r # gmapQ :: (forall d. Data d => d -> u) -> MediaBag -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> MediaBag -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> MediaBag -> m MediaBag # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MediaBag -> m MediaBag # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MediaBag -> m MediaBag #
Show MediaBag Source #
Instance details Defined in Text.Pandoc.MediaBag Methods showsPrec :: Int -> MediaBag -> ShowS # show :: MediaBag -> String # showList :: [MediaBag] -> ShowS #
Semigroup MediaBag Source #
Instance details Defined in Text.Pandoc.MediaBag Methods (<>) :: MediaBag -> MediaBag -> MediaBag # sconcat :: NonEmpty MediaBag -> MediaBag # stimes :: Integral b => b -> MediaBag -> MediaBag #
Monoid MediaBag Source #
Instance details Defined in Text.Pandoc.MediaBag Methods mempty :: MediaBag # mappend :: MediaBag -> MediaBag -> MediaBag # mconcat :: [MediaBag] -> MediaBag #

deleteMedia Source #

Arguments

:: FilePath	relative path and canonical name of resource
-> MediaBag
-> MediaBag

Delete a media item from a MediaBag, or do nothing if no item corresponds to the given path.

lookupMedia :: FilePath -> MediaBag -> Maybe (MimeType, ByteString) Source #

Lookup a media item in a MediaBag, returning mime type and contents.

insertMedia Source #

Arguments

:: FilePath	relative path and canonical name of resource
-> Maybe MimeType	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 -> [(FilePath, MimeType, Int)] Source #

Get a list of the file paths stored in a MediaBag, with their corresponding mime types and the lengths in bytes of the contents.

mediaItems :: MediaBag -> [(FilePath, MimeType, ByteString)] Source #