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

Text.Pandoc.MediaBag

Description

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

Synopsis

dataMediaItem =MediaItem {
- mediaMimeType ::MimeType
- mediaPath ::FilePath
- mediaContents ::ByteString
}
dataMediaBag
deleteMedia ::FilePath ->MediaBag ->MediaBag
lookupMedia ::FilePath ->MediaBag ->Maybe MediaItem
insertMedia ::FilePath ->Maybe MimeType ->ByteString ->MediaBag ->MediaBag
mediaDirectory ::MediaBag -> [(FilePath,MimeType,Int)]
mediaItems ::MediaBag -> [(FilePath,MimeType,ByteString)]

Documentation

dataMediaItem Source #

Constructors

MediaItem
Fields mediaMimeType ::MimeType mediaPath ::FilePath mediaContents ::ByteString

Instances

Instances details

Data MediaItemSource #
Instance details Defined inText.Pandoc.MediaBag Methods gfoldl :: (forall d b.Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) ->MediaItem -> cMediaItem # gunfold :: (forall b r.Data b => c (b -> r) -> c r) -> (forall r. r -> c r) ->Constr -> cMediaItem # toConstr ::MediaItem ->Constr # dataTypeOf ::MediaItem ->DataType # dataCast1 ::Typeable t => (forall d.Data d => c (t d)) ->Maybe (cMediaItem)# dataCast2 ::Typeable t => (forall d e. (Data d,Data e) => c (t d e)) ->Maybe (cMediaItem)# 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 -> mMediaItem # gmapMp ::MonadPlus m => (forall d.Data d => d -> m d) ->MediaItem -> mMediaItem # gmapMo ::MonadPlus m => (forall d.Data d => d -> m d) ->MediaItem -> mMediaItem #
Show MediaItemSource #
Instance details Defined inText.Pandoc.MediaBag Methods showsPrec ::Int ->MediaItem ->ShowS # show ::MediaItem ->String # showList :: [MediaItem] ->ShowS #
Eq MediaItemSource #
Instance details Defined inText.Pandoc.MediaBag Methods (==) ::MediaItem ->MediaItem ->Bool # (/=) ::MediaItem ->MediaItem ->Bool #
Ord MediaItemSource #
Instance details Defined inText.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 #

dataMediaBag Source #

A container for a collection of binary resources, with names and mime types. Note that aMediaBag is a Monoid, somempty can be used for an emptyMediaBag, and<> can be used to append twoMediaBags.

Instances

Instances details

Data MediaBagSource #
Instance details Defined inText.Pandoc.MediaBag Methods gfoldl :: (forall d b.Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) ->MediaBag -> cMediaBag # gunfold :: (forall b r.Data b => c (b -> r) -> c r) -> (forall r. r -> c r) ->Constr -> cMediaBag # toConstr ::MediaBag ->Constr # dataTypeOf ::MediaBag ->DataType # dataCast1 ::Typeable t => (forall d.Data d => c (t d)) ->Maybe (cMediaBag)# dataCast2 ::Typeable t => (forall d e. (Data d,Data e) => c (t d e)) ->Maybe (cMediaBag)# 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 -> mMediaBag # gmapMp ::MonadPlus m => (forall d.Data d => d -> m d) ->MediaBag -> mMediaBag # gmapMo ::MonadPlus m => (forall d.Data d => d -> m d) ->MediaBag -> mMediaBag #
Monoid MediaBagSource #
Instance details Defined inText.Pandoc.MediaBag Methods mempty ::MediaBag # mappend ::MediaBag ->MediaBag ->MediaBag # mconcat :: [MediaBag] ->MediaBag #
Semigroup MediaBagSource #
Instance details Defined inText.Pandoc.MediaBag Methods (<>) ::MediaBag ->MediaBag ->MediaBag # sconcat ::NonEmpty MediaBag ->MediaBag # stimes ::Integral b => b ->MediaBag ->MediaBag #
Show MediaBagSource #
Instance details Defined inText.Pandoc.MediaBag Methods showsPrec ::Int ->MediaBag ->ShowS # show ::MediaBag ->String # showList :: [MediaBag] ->ShowS #

deleteMedia Source #

Arguments

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

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

lookupMedia ::FilePath ->MediaBag ->Maybe MediaItem Source #

Lookup a media item in aMediaBag, 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 aMediaBag, replacing any existing value with the same name.

mediaDirectory ::MediaBag -> [(FilePath,MimeType,Int)]Source #

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

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

Movatterモバイル変換

Documentation

Instances

Instances