/usr/share/doc/libghc-yaml-doc/html/Text-Libyaml.html is in libghc-yaml-doc 0.5.2-3.
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 12 | <!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.Libyaml</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Text-Libyaml.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Text-Libyaml.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">yaml-0.5.2: Low-level binding to the libyaml C library.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Text.Libyaml</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">The event stream
</a></li><li><a href="#g:2">Encoding and decoding
</a></li><li><a href="#g:3">Exception
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Low-level, streaming YAML interface. For a higher-level interface, see
<a href="Data-Yaml.html">Data.Yaml</a>.
</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:Event">Event</a> <ul class="subs"><li>= <a href="#v:EventStreamStart">EventStreamStart</a> </li><li>| <a href="#v:EventStreamEnd">EventStreamEnd</a> </li><li>| <a href="#v:EventDocumentStart">EventDocumentStart</a> </li><li>| <a href="#v:EventDocumentEnd">EventDocumentEnd</a> </li><li>| <a href="#v:EventAlias">EventAlias</a> !<a href="Text-Libyaml.html#t:AnchorName">AnchorName</a> </li><li>| <a href="#v:EventScalar">EventScalar</a> !<a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> !<a href="Text-Libyaml.html#t:Tag">Tag</a> !<a href="Text-Libyaml.html#t:Style">Style</a> !<a href="Text-Libyaml.html#t:Anchor">Anchor</a> </li><li>| <a href="#v:EventSequenceStart">EventSequenceStart</a> !<a href="Text-Libyaml.html#t:Anchor">Anchor</a> </li><li>| <a href="#v:EventSequenceEnd">EventSequenceEnd</a> </li><li>| <a href="#v:EventMappingStart">EventMappingStart</a> !<a href="Text-Libyaml.html#t:Anchor">Anchor</a> </li><li>| <a href="#v:EventMappingEnd">EventMappingEnd</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Style">Style</a> <ul class="subs"><li>= <a href="#v:Any">Any</a> </li><li>| <a href="#v:Plain">Plain</a> </li><li>| <a href="#v:SingleQuoted">SingleQuoted</a> </li><li>| <a href="#v:DoubleQuoted">DoubleQuoted</a> </li><li>| <a href="#v:Literal">Literal</a> </li><li>| <a href="#v:Folded">Folded</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Tag">Tag</a> <ul class="subs"><li>= <a href="#v:StrTag">StrTag</a> </li><li>| <a href="#v:FloatTag">FloatTag</a> </li><li>| <a href="#v:NullTag">NullTag</a> </li><li>| <a href="#v:BoolTag">BoolTag</a> </li><li>| <a href="#v:SetTag">SetTag</a> </li><li>| <a href="#v:IntTag">IntTag</a> </li><li>| <a href="#v:SeqTag">SeqTag</a> </li><li>| <a href="#v:MapTag">MapTag</a> </li><li>| <a href="#v:UriTag">UriTag</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> </li><li>| <a href="#v:NoTag">NoTag</a> </li></ul></li><li class="src short"><span class="keyword">type</span> <a href="#t:AnchorName">AnchorName</a> = <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:Anchor">Anchor</a> = <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Text-Libyaml.html#t:AnchorName">AnchorName</a></li><li class="src short"><a href="#v:encode">encode</a> :: <a href="/usr/share/doc/libghc-conduit-doc/html/Control-Monad-Trans-Resource.html#t:ResourceIO">ResourceIO</a> m => <a href="/usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Sink">Sink</a> <a href="Text-Libyaml.html#t:Event">Event</a> m <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:decode">decode</a> :: <a href="/usr/share/doc/libghc-conduit-doc/html/Control-Monad-Trans-Resource.html#t:ResourceIO">ResourceIO</a> m => <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Source">Source</a> m <a href="Text-Libyaml.html#t:Event">Event</a></li><li class="src short"><a href="#v:encodeFile">encodeFile</a> :: <a href="/usr/share/doc/libghc-conduit-doc/html/Control-Monad-Trans-Resource.html#t:ResourceIO">ResourceIO</a> m => <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Sink">Sink</a> <a href="Text-Libyaml.html#t:Event">Event</a> m <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:decodeFile">decodeFile</a> :: <a href="/usr/share/doc/libghc-conduit-doc/html/Control-Monad-Trans-Resource.html#t:ResourceIO">ResourceIO</a> m => <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Source">Source</a> m <a href="Text-Libyaml.html#t:Event">Event</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:YamlException">YamlException</a> = <a href="#v:YamlException">YamlException</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li></ul></div><div id="interface"><h1 id="g:1">The event stream
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Event" class="def">Event</a> <a href="src/Text-Libyaml.html#Event" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:EventStreamStart" class="def">EventStreamStart</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:EventStreamEnd" class="def">EventStreamEnd</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:EventDocumentStart" class="def">EventDocumentStart</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:EventDocumentEnd" class="def">EventDocumentEnd</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:EventAlias" class="def">EventAlias</a> !<a href="Text-Libyaml.html#t:AnchorName">AnchorName</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:EventScalar" class="def">EventScalar</a> !<a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> !<a href="Text-Libyaml.html#t:Tag">Tag</a> !<a href="Text-Libyaml.html#t:Style">Style</a> !<a href="Text-Libyaml.html#t:Anchor">Anchor</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:EventSequenceStart" class="def">EventSequenceStart</a> !<a href="Text-Libyaml.html#t:Anchor">Anchor</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:EventSequenceEnd" class="def">EventSequenceEnd</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:EventMappingStart" class="def">EventMappingStart</a> !<a href="Text-Libyaml.html#t:Anchor">Anchor</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:EventMappingEnd" class="def">EventMappingEnd</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Event" class="caption collapser" onclick="toggleSection('i:Event')">Instances</p><div id="section.i:Event" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Text-Libyaml.html#t:Event">Event</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Text-Libyaml.html#t:Event">Event</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Style" class="def">Style</a> <a href="src/Text-Libyaml.html#Style" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Any" class="def">Any</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Plain" class="def">Plain</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:SingleQuoted" class="def">SingleQuoted</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:DoubleQuoted" class="def">DoubleQuoted</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Literal" class="def">Literal</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Folded" class="def">Folded</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Style" class="caption collapser" onclick="toggleSection('i:Style')">Instances</p><div id="section.i:Style" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Bounded">Bounded</a> <a href="Text-Libyaml.html#t:Style">Style</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Enum">Enum</a> <a href="Text-Libyaml.html#t:Style">Style</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Text-Libyaml.html#t:Style">Style</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Data.html#t:Data">Data</a> <a href="Text-Libyaml.html#t:Style">Style</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ord">Ord</a> <a href="Text-Libyaml.html#t:Style">Style</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> <a href="Text-Libyaml.html#t:Style">Style</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Text-Libyaml.html#t:Style">Style</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> <a href="Text-Libyaml.html#t:Style">Style</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Tag" class="def">Tag</a> <a href="src/Text-Libyaml.html#Tag" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:StrTag" class="def">StrTag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:FloatTag" class="def">FloatTag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:NullTag" class="def">NullTag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:BoolTag" class="def">BoolTag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:SetTag" class="def">SetTag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:IntTag" class="def">IntTag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:SeqTag" class="def">SeqTag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:MapTag" class="def">MapTag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:UriTag" class="def">UriTag</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:NoTag" class="def">NoTag</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Tag" class="caption collapser" onclick="toggleSection('i:Tag')">Instances</p><div id="section.i:Tag" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Text-Libyaml.html#t:Tag">Tag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Data.html#t:Data">Data</a> <a href="Text-Libyaml.html#t:Tag">Tag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> <a href="Text-Libyaml.html#t:Tag">Tag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Text-Libyaml.html#t:Tag">Tag</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> <a href="Text-Libyaml.html#t:Tag">Tag</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:AnchorName" class="def">AnchorName</a> = <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Text-Libyaml.html#AnchorName" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Anchor" class="def">Anchor</a> = <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Text-Libyaml.html#t:AnchorName">AnchorName</a><a href="src/Text-Libyaml.html#Anchor" class="link">Source</a></p></div><h1 id="g:2">Encoding and decoding
</h1><div class="top"><p class="src"><a name="v:encode" class="def">encode</a> :: <a href="/usr/share/doc/libghc-conduit-doc/html/Control-Monad-Trans-Resource.html#t:ResourceIO">ResourceIO</a> m => <a href="/usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Sink">Sink</a> <a href="Text-Libyaml.html#t:Event">Event</a> m <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a><a href="src/Text-Libyaml.html#encode" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:decode" class="def">decode</a> :: <a href="/usr/share/doc/libghc-conduit-doc/html/Control-Monad-Trans-Resource.html#t:ResourceIO">ResourceIO</a> m => <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Source">Source</a> m <a href="Text-Libyaml.html#t:Event">Event</a><a href="src/Text-Libyaml.html#decode" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:encodeFile" class="def">encodeFile</a> :: <a href="/usr/share/doc/libghc-conduit-doc/html/Control-Monad-Trans-Resource.html#t:ResourceIO">ResourceIO</a> m => <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Sink">Sink</a> <a href="Text-Libyaml.html#t:Event">Event</a> m <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/Text-Libyaml.html#encodeFile" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:decodeFile" class="def">decodeFile</a> :: <a href="/usr/share/doc/libghc-conduit-doc/html/Control-Monad-Trans-Resource.html#t:ResourceIO">ResourceIO</a> m => <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/libghc-conduit-doc/html/Data-Conduit.html#t:Source">Source</a> m <a href="Text-Libyaml.html#t:Event">Event</a><a href="src/Text-Libyaml.html#decodeFile" class="link">Source</a></p></div><h1 id="g:3">Exception
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:YamlException" class="def">YamlException</a> <a href="src/Text-Libyaml.html#YamlException" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:YamlException" class="def">YamlException</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:YamlException" class="caption collapser" onclick="toggleSection('i:YamlException')">Instances</p><div id="section.i:YamlException" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Text-Libyaml.html#t:YamlException">YamlException</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> <a href="Text-Libyaml.html#t:YamlException">YamlException</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Exception-Base.html#t:Exception">Exception</a> <a href="Text-Libyaml.html#t:YamlException">YamlException</a></td><td class="doc empty"> </td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
|