/usr/share/doc/libghc-pandoc-doc/html/Text-Pandoc-MediaBag.html is in libghc-pandoc-doc 1.19.2.4~dfsg-1build4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Text.Pandoc.MediaBag</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Text-Pandoc-MediaBag.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Text-Pandoc-MediaBag.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">pandoc-1.19.2.4: Conversion between markup formats</p></div><div id="content"><div id="module-header"><table class="info"><tr><th valign="top">Copyright</th><td>Copyright (C) 2014 John MacFarlane</td></tr><tr><th>License</th><td>GNU GPL, version 2 or above</td></tr><tr><th>Maintainer</th><td>John MacFarlane <jgm@berkeley.edu></td></tr><tr><th>Stability</th><td>alpha</td></tr><tr><th>Portability</th><td>portable</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">Text.Pandoc.MediaBag</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Definition of a MediaBag object to hold binary resources, and an
interface for interacting with it.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:MediaBag">MediaBag</a></li><li class="src short"><a href="#v:lookupMedia">lookupMedia</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Maybe.html#t:Maybe">Maybe</a> (MimeType, <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a>)</li><li class="src short"><a href="#v:insertMedia">insertMedia</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Maybe.html#t:Maybe">Maybe</a> MimeType -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a></li><li class="src short"><a href="#v:mediaDirectory">mediaDirectory</a> :: <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> [(<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-String.html#t:String">String</a>, MimeType, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a>)]</li><li class="src short"><a href="#v:extractMediaBag">extractMediaBag</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> ()</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:MediaBag" class="def">MediaBag</a> <a href="src/Text-Pandoc-MediaBag.html#MediaBag" class="link">Source</a> <a href="#t:MediaBag" class="selflink">#</a></p><div class="doc"><p>A container for a collection of binary resources, with names and
mime types. Note that a <code><a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a></code> is a Monoid, so <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Monoid.html#v:mempty">mempty</a></code>
can be used for an empty <code><a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a></code>, and <code><></code> can be used to append
two <code><a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a></code>s.</p></div><div class="subs instances"><p id="control.i:MediaBag" class="caption collapser" onclick="toggleSection('i:MediaBag')">Instances</p><div id="section.i:MediaBag" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:MediaBag:Data:1" class="instance expander" onclick="toggleSection('i:id:MediaBag:Data:1')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a></span> <a href="src/Text-Pandoc-MediaBag.html#line-57" class="link">Source</a> <a href="#t:MediaBag" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:MediaBag:Data:1" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:gfoldl">gfoldl</a> :: (<span class="keyword">forall</span> d b. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> d => c (d -> b) -> d -> c b) -> (<span class="keyword">forall</span> g. g -> c g) -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> c <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> <a href="#v:gfoldl" class="selflink">#</a></p><p class="src"><a href="#v:gunfold">gunfold</a> :: (<span class="keyword">forall</span> b r. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> b => c (b -> r) -> c r) -> (<span class="keyword">forall</span> r. r -> c r) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Constr">Constr</a> -> c <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> <a href="#v:gunfold" class="selflink">#</a></p><p class="src"><a href="#v:toConstr">toConstr</a> :: <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Constr">Constr</a> <a href="#v:toConstr" class="selflink">#</a></p><p class="src"><a href="#v:dataTypeOf">dataTypeOf</a> :: <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:DataType">DataType</a> <a href="#v:dataTypeOf" class="selflink">#</a></p><p class="src"><a href="#v:dataCast1">dataCast1</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Kind.html#t:-42-">*</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Kind.html#t:-42-">*</a>) t => (<span class="keyword">forall</span> d. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> d => c (t d)) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Maybe.html#t:Maybe">Maybe</a> (c <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a>) <a href="#v:dataCast1" class="selflink">#</a></p><p class="src"><a href="#v:dataCast2">dataCast2</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Kind.html#t:-42-">*</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Kind.html#t:-42-">*</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Kind.html#t:-42-">*</a>) t => (<span class="keyword">forall</span> d e. (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> d, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> e) => c (t d e)) -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Maybe.html#t:Maybe">Maybe</a> (c <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a>) <a href="#v:dataCast2" class="selflink">#</a></p><p class="src"><a href="#v:gmapT">gmapT</a> :: (<span class="keyword">forall</span> b. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> b => b -> b) -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> <a href="#v:gmapT" class="selflink">#</a></p><p class="src"><a href="#v:gmapQl">gmapQl</a> :: (r -> r' -> r) -> r -> (<span class="keyword">forall</span> d. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> d => d -> r') -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> r <a href="#v:gmapQl" class="selflink">#</a></p><p class="src"><a href="#v:gmapQr">gmapQr</a> :: (r' -> r -> r) -> r -> (<span class="keyword">forall</span> d. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> d => d -> r') -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> r <a href="#v:gmapQr" class="selflink">#</a></p><p class="src"><a href="#v:gmapQ">gmapQ</a> :: (<span class="keyword">forall</span> d. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> d => d -> u) -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> [u] <a href="#v:gmapQ" class="selflink">#</a></p><p class="src"><a href="#v:gmapQi">gmapQi</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a> -> (<span class="keyword">forall</span> d. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> d => d -> u) -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> u <a href="#v:gmapQi" class="selflink">#</a></p><p class="src"><a href="#v:gmapM">gmapM</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Control-Monad.html#t:Monad">Monad</a> m => (<span class="keyword">forall</span> d. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> d => d -> m d) -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> m <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> <a href="#v:gmapM" class="selflink">#</a></p><p class="src"><a href="#v:gmapMp">gmapMp</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Control-Monad.html#t:MonadPlus">MonadPlus</a> m => (<span class="keyword">forall</span> d. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> d => d -> m d) -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> m <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> <a href="#v:gmapMp" class="selflink">#</a></p><p class="src"><a href="#v:gmapMo">gmapMo</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Control-Monad.html#t:MonadPlus">MonadPlus</a> m => (<span class="keyword">forall</span> d. <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Data.html#t:Data">Data</a> d => d -> m d) -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> m <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> <a href="#v:gmapMo" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:MediaBag:Show:2" class="instance expander" onclick="toggleSection('i:id:MediaBag:Show:2')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Text-Show.html#t:Show">Show</a> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a></span> <a href="src/Text-Pandoc-MediaBag.html#line-59" class="link">Source</a> <a href="#t:MediaBag" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:MediaBag:Show:2" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showsPrec" class="selflink">#</a></p><p class="src"><a href="#v:show">show</a> :: <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-String.html#t:String">String</a> <a href="#v:show" class="selflink">#</a></p><p class="src"><a href="#v:showList">showList</a> :: [<a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Text-Show.html#t:ShowS">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></div></td></tr><tr><td class="src clearfix"><span class="inst-left"><span id="control.i:id:MediaBag:Monoid:3" class="instance expander" onclick="toggleSection('i:id:MediaBag:Monoid:3')"></span> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Monoid.html#t:Monoid">Monoid</a> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a></span> <a href="src/Text-Pandoc-MediaBag.html#line-57" class="link">Source</a> <a href="#t:MediaBag" class="selflink">#</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div id="section.i:id:MediaBag:Monoid:3" class="inst-details hide"><div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:mempty">mempty</a> :: <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> <a href="#v:mempty" class="selflink">#</a></p><p class="src"><a href="#v:mappend">mappend</a> :: <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> <a href="#v:mappend" class="selflink">#</a></p><p class="src"><a href="#v:mconcat">mconcat</a> :: [<a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a>] -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> <a href="#v:mconcat" class="selflink">#</a></p></div></div></td></tr></table></div></div></div><div class="top"><p class="src"><a id="v:lookupMedia" class="def">lookupMedia</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Maybe.html#t:Maybe">Maybe</a> (MimeType, <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a>) <a href="src/Text-Pandoc-MediaBag.html#lookupMedia" class="link">Source</a> <a href="#v:lookupMedia" class="selflink">#</a></p><div class="doc"><p>Lookup a media item in a <code><a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a></code>, returning mime type and contents.</p></div></div><div class="top"><p class="src"><a id="v:insertMedia" class="def">insertMedia</a> <a href="src/Text-Pandoc-MediaBag.html#insertMedia" class="link">Source</a> <a href="#v:insertMedia" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a></td><td class="doc"><p>relative path and canonical name of resource</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Maybe.html#t:Maybe">Maybe</a> MimeType</td><td class="doc"><p>mime type (Nothing = determine from extension)</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></td><td class="doc"><p>contents of resource</p></td></tr><tr><td class="src">-> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Insert a media item into a <code><a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a></code>, replacing any existing
value with the same name.</p></div></div><div class="top"><p class="src"><a id="v:mediaDirectory" class="def">mediaDirectory</a> :: <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> [(<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-String.html#t:String">String</a>, MimeType, <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Int.html#t:Int">Int</a>)] <a href="src/Text-Pandoc-MediaBag.html#mediaDirectory" class="link">Source</a> <a href="#v:mediaDirectory" class="selflink">#</a></p><div class="doc"><p>Get a list of the file paths stored in a <code><a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a></code>, with
their corresponding mime types and the lengths in bytes of the contents.</p></div></div><div class="top"><p class="src"><a id="v:extractMediaBag" class="def">extractMediaBag</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Text-Pandoc-MediaBag.html#t:MediaBag">MediaBag</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.1.0/System-IO.html#t:IO">IO</a> () <a href="src/Text-Pandoc-MediaBag.html#extractMediaBag" class="link">Source</a> <a href="#v:extractMediaBag" class="selflink">#</a></p><div class="doc"><p>Extract contents of MediaBag to a given directory. Print informational
messages if <code>verbose</code> is true.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.3</p></div></body></html>
|