Text.Pandoc.MediaBag

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

Documentation

data MediaItem

Constructors

MediaItem

Fields

• mediaMimeType :: MimeType
• mediaPath :: FilePath
• mediaContents :: ByteString

Instances

Eq MediaItem

Defined in Text.Pandoc.MediaBag

Methods

(==) :: MediaItem -> MediaItem -> Bool

(/=) :: MediaItem -> MediaItem -> Bool

Data MediaItem

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

Ord MediaItem

Defined in Text.Pandoc.MediaBag

Methods

compare :: MediaItem -> MediaItem -> Ordering

(<) :: MediaItem -> MediaItem -> Bool

(<=) :: MediaItem -> MediaItem -> Bool

(>) :: MediaItem -> MediaItem -> Bool

(>=) :: MediaItem -> MediaItem -> Bool

max :: MediaItem -> MediaItem -> MediaItem

min :: MediaItem -> MediaItem -> MediaItem

Show MediaItem

Defined in Text.Pandoc.MediaBag

Methods

showsPrec :: Int -> MediaItem -> ShowS

show :: MediaItem -> String

showList :: [MediaItem] -> ShowS

data MediaBag

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

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

Show MediaBag

Defined in Text.Pandoc.MediaBag

Methods

showsPrec :: Int -> MediaBag -> ShowS

show :: MediaBag -> String

showList :: [MediaBag] -> ShowS

Semigroup MediaBag

Defined in Text.Pandoc.MediaBag

Methods

(<>) :: MediaBag -> MediaBag -> MediaBag

sconcat :: NonEmpty MediaBag -> MediaBag

stimes :: Integral b => b -> MediaBag -> MediaBag

Monoid MediaBag

Defined in Text.Pandoc.MediaBag

Methods

mempty :: MediaBag

mappend :: MediaBag -> MediaBag -> MediaBag

mconcat :: [MediaBag] -> MediaBag

deleteMedia

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

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

insertMedia

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)]

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)]