pandoc-3.1.2: Conversion between markup formats
CopyrightCopyright (C) 2014-2015 2017-2023 John MacFarlane
LicenseGNU GPL, version 2 or above
MaintainerJohn MacFarlane <jgm@berkeley.edu>
Stabilityalpha
Portabilityportable
Safe HaskellSafe-Inferred
LanguageHaskell2010

Text.Pandoc.MediaBag

Description

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

Synopsis

Documentation

data MediaItem Source #

Instances

Instances details
Data MediaItem 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) -> MediaItem -> c MediaItem #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MediaItem #

toConstr :: MediaItem -> Constr #

dataTypeOf :: MediaItem -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MediaItem) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MediaItem) #

gmapT :: (forall b. Data b => b -> b) -> MediaItem -> MediaItem #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MediaItem -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MediaItem -> r #

gmapQ :: (forall d. Data d => d -> u) -> MediaItem -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MediaItem -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MediaItem -> m MediaItem #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MediaItem -> m MediaItem #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MediaItem -> m MediaItem #

Show MediaItem Source # 
Instance details

Defined in Text.Pandoc.MediaBag

Eq MediaItem Source # 
Instance details

Defined in Text.Pandoc.MediaBag

Ord MediaItem Source # 
Instance details

Defined in Text.Pandoc.MediaBag

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

Instances details
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 :: forall r r'. (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 #

Monoid MediaBag Source # 
Instance details

Defined in Text.Pandoc.MediaBag

Semigroup MediaBag Source # 
Instance details

Defined in Text.Pandoc.MediaBag

Show MediaBag Source # 
Instance details

Defined in Text.Pandoc.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 MediaItem 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.