/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.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 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | <!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>Data.Yaml</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_Data-Yaml.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Data-Yaml.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>Safe-Infered</td></tr></table><p class="caption">Data.Yaml</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Types
</a></li><li><a href="#g:2">Constructors and accessors
</a></li><li><a href="#g:3">Parsing
</a></li><li><a href="#g:4">Classes
</a></li><li><a href="#g:5">Encoding/decoding
</a></li></ul></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:Value">Value</a> <ul class="subs"><li>= <a href="#v:Object">Object</a> !<a href="Data-Yaml.html#t:Object">Object</a> </li><li>| <a href="#v:Array">Array</a> !<a href="Data-Yaml.html#t:Array">Array</a> </li><li>| <a href="#v:String">String</a> !Text </li><li>| <a href="#v:Number">Number</a> !<a href="/usr/share/doc/libghc-attoparsec-doc/html/Data-Attoparsec-Number.html#t:Number">Number</a> </li><li>| <a href="#v:Bool">Bool</a> !<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a> </li><li>| <a href="#v:Null">Null</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Parser">Parser</a> a</li><li class="src short"><span class="keyword">type</span> <a href="#t:Object">Object</a> = <a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashMap-Lazy.html#t:HashMap">HashMap</a> Text <a href="Data-Yaml.html#t:Value">Value</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:Array">Array</a> = <a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector.html#t:Vector">Vector</a> <a href="Data-Yaml.html#t:Value">Value</a></li><li class="src short"><a href="#v:object">object</a> :: [<a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#t:Pair">Pair</a>] -> <a href="Data-Yaml.html#t:Value">Value</a></li><li class="src short"><a href="#v:array">array</a> :: [<a href="Data-Yaml.html#t:Value">Value</a>] -> <a href="Data-Yaml.html#t:Value">Value</a></li><li class="src short"><a href="#v:.-61-">(.=)</a> :: <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => Text -> a -> <a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#t:Pair">Pair</a></li><li class="src short"><a href="#v:.:">(.:)</a> :: <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <a href="Data-Yaml.html#t:Object">Object</a> -> Text -> <a href="Data-Yaml.html#t:Parser">Parser</a> a</li><li class="src short"><a href="#v:.:-63-">(.:?)</a> :: <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <a href="Data-Yaml.html#t:Object">Object</a> -> Text -> <a href="Data-Yaml.html#t:Parser">Parser</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a)</li><li class="src short"><a href="#v:.-33--61-">(.!=)</a> :: <a href="Data-Yaml.html#t:Parser">Parser</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a) -> a -> <a href="Data-Yaml.html#t:Parser">Parser</a> a</li><li class="src short"><a href="#v:parseMonad">parseMonad</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> m => (a -> <a href="Data-Yaml.html#t:Parser">Parser</a> b) -> a -> m b</li><li class="src short"><a href="#v:parseEither">parseEither</a> :: (a -> <a href="Data-Yaml.html#t:Parser">Parser</a> b) -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> b</li><li class="src short"><a href="#v:parseMaybe">parseMaybe</a> :: (a -> <a href="Data-Yaml.html#t:Parser">Parser</a> b) -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> b</li><li class="src short"><span class="keyword">class</span> <a href="#t:ToJSON">ToJSON</a> a <span class="keyword">where</span><ul class="subs"><li><a href="#v:toJSON">toJSON</a> :: a -> <a href="Data-Yaml.html#t:Value">Value</a></li></ul></li><li class="src short"><span class="keyword">class</span> <a href="#t:FromJSON">FromJSON</a> a <span class="keyword">where</span><ul class="subs"><li><a href="#v:parseJSON">parseJSON</a> :: <a href="Data-Yaml.html#t:Value">Value</a> -> <a href="Data-Yaml.html#t:Parser">Parser</a> a</li></ul></li><li class="src short"><a href="#v:encode">encode</a> :: <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => a -> <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:encodeFile">encodeFile</a> :: <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <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:decode">decode</a> :: <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <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/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a</li><li class="src short"><a href="#v:decodeFile">decodeFile</a> :: <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <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/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a)</li></ul></div><div id="interface"><h1 id="g:1">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Value" class="def">Value</a> </p><div class="doc"><p>A JSON value represented as a Haskell value.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Object" class="def">Object</a> !<a href="Data-Yaml.html#t:Object">Object</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Array" class="def">Array</a> !<a href="Data-Yaml.html#t:Array">Array</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:String" class="def">String</a> !Text</td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Number" class="def">Number</a> !<a href="/usr/share/doc/libghc-attoparsec-doc/html/Data-Attoparsec-Number.html#t:Number">Number</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Bool" class="def">Bool</a> !<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Null" class="def">Null</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Value" class="caption collapser" onclick="toggleSection('i:Value')">Instances</p><div id="section.i:Value" 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="Data-Yaml.html#t:Value">Value</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="Data-Yaml.html#t:Value">Value</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="Data-Yaml.html#t:Value">Value</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-String.html#t:IsString">IsString</a> <a href="Data-Yaml.html#t:Value">Value</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="Data-Yaml.html#t:Value">Value</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="Data-Yaml.html#t:Value">Value</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/deepseq-1.3.0.0/Control-DeepSeq.html#t:NFData">NFData</a> <a href="Data-Yaml.html#t:Value">Value</a></td><td class="doc empty"> </td></tr><tr><td class="src">Hashable <a href="Data-Yaml.html#t:Value">Value</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:Parser" class="def">Parser</a> a </p><div class="doc"><p>A continuation-based parser type.
</p></div><div class="subs instances"><p id="control.i:Parser" class="caption collapser" onclick="toggleSection('i:Parser')">Instances</p><div id="section.i:Parser" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> <a href="Data-Yaml.html#t:Parser">Parser</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-Monad.html#t:Functor">Functor</a> <a href="Data-Yaml.html#t:Parser">Parser</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-Monad.html#t:MonadPlus">MonadPlus</a> <a href="Data-Yaml.html#t:Parser">Parser</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-Applicative.html#t:Applicative">Applicative</a> <a href="Data-Yaml.html#t:Parser">Parser</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-Applicative.html#t:Alternative">Alternative</a> <a href="Data-Yaml.html#t:Parser">Parser</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-Monoid.html#t:Monoid">Monoid</a> (<a href="Data-Yaml.html#t:Parser">Parser</a> 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:Object" class="def">Object</a> = <a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashMap-Lazy.html#t:HashMap">HashMap</a> Text <a href="Data-Yaml.html#t:Value">Value</a></p><div class="doc"><p>A JSON "object" (key/value map).
</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Array" class="def">Array</a> = <a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector.html#t:Vector">Vector</a> <a href="Data-Yaml.html#t:Value">Value</a></p><div class="doc"><p>A JSON "array" (sequence).
</p></div></div><h1 id="g:2">Constructors and accessors
</h1><div class="top"><p class="src"><a name="v:object" class="def">object</a> :: [<a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#t:Pair">Pair</a>] -> <a href="Data-Yaml.html#t:Value">Value</a></p><div class="doc"><p>Create a <code><a href="Data-Yaml.html#t:Value">Value</a></code> from a list of name/value <code><a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#t:Pair">Pair</a></code>s. If duplicate
keys arise, earlier keys and their associated values win.
</p></div></div><div class="top"><p class="src"><a name="v:array" class="def">array</a> :: [<a href="Data-Yaml.html#t:Value">Value</a>] -> <a href="Data-Yaml.html#t:Value">Value</a><a href="src/Data-Yaml.html#array" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:.-61-" class="def">(.=)</a> :: <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => Text -> a -> <a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#t:Pair">Pair</a></p><div class="doc"><p>Construct a <code><a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#t:Pair">Pair</a></code> from a key and a value.
</p></div></div><div class="top"><p class="src"><a name="v:.:" class="def">(.:)</a> :: <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <a href="Data-Yaml.html#t:Object">Object</a> -> Text -> <a href="Data-Yaml.html#t:Parser">Parser</a> a</p><div class="doc"><p>Retrieve the value associated with the given key of an <code><a href="Data-Yaml.html#t:Object">Object</a></code>.
The result is <code>empty</code> if the key is not present or the value cannot
be converted to the desired type.
</p><p>This accessor is appropriate if the key and value <em>must</em> be present
in an object for it to be valid. If the key and value are
optional, use '(.:?)' instead.
</p></div></div><div class="top"><p class="src"><a name="v:.:-63-" class="def">(.:?)</a> :: <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <a href="Data-Yaml.html#t:Object">Object</a> -> Text -> <a href="Data-Yaml.html#t:Parser">Parser</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a)</p><div class="doc"><p>Retrieve the value associated with the given key of an <code><a href="Data-Yaml.html#t:Object">Object</a></code>.
The result is <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#v:Nothing">Nothing</a></code> if the key is not present, or <code>empty</code> if
the value cannot be converted to the desired type.
</p><p>This accessor is most useful if the key and value can be absent
from an object without affecting its validity. If the key and
value are mandatory, use '(.:)' instead.
</p></div></div><div class="top"><p class="src"><a name="v:.-33--61-" class="def">(.!=)</a> :: <a href="Data-Yaml.html#t:Parser">Parser</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a) -> a -> <a href="Data-Yaml.html#t:Parser">Parser</a> a</p><div class="doc"><p>Helper for use in combination with <code><a href="Data-Yaml.html#v:.:-63-">.:?</a></code> to provide default
values for optional JSON object fields.
</p><p>This combinator is most useful if the key and value can be absent
from an object without affecting its validity and we know a default
value to assign in that case. If the key and value are mandatory,
use '(.:)' instead.
</p><p>Example usage:
</p><pre> v1 <- o <code><a href="Data-Yaml.html#v:.:-63-">.:?</a></code> "opt_field_with_dfl" .!= "default_val"
v2 <- o <code><a href="Data-Yaml.html#v:.:">.:</a></code> "mandatory_field"
v3 <- o <code><a href="Data-Yaml.html#v:.:-63-">.:?</a></code> "opt_field2"
</pre></div></div><h1 id="g:3">Parsing
</h1><div class="top"><p class="src"><a name="v:parseMonad" class="def">parseMonad</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#t:Monad">Monad</a> m => (a -> <a href="Data-Yaml.html#t:Parser">Parser</a> b) -> a -> m b<a href="src/Data-Yaml.html#parseMonad" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:parseEither" class="def">parseEither</a> :: (a -> <a href="Data-Yaml.html#t:Parser">Parser</a> b) -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> b</p><div class="doc"><p>Run a <code><a href="Data-Yaml.html#t:Parser">Parser</a></code> with an <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Either.html#t:Either">Either</a></code> result type.
</p></div></div><div class="top"><p class="src"><a name="v:parseMaybe" class="def">parseMaybe</a> :: (a -> <a href="Data-Yaml.html#t:Parser">Parser</a> b) -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> b</p><div class="doc"><p>Run a <code><a href="Data-Yaml.html#t:Parser">Parser</a></code> with a <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a></code> result type.
</p></div></div><h1 id="g:4">Classes
</h1><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:ToJSON" class="def">ToJSON</a> a <span class="keyword">where</span></p><div class="doc"><p>A type that can be converted to JSON.
</p><p>An example type and instance:
</p><pre>{-# LANGUAGE OverloadedStrings #-}
data Coord { x :: Double, y :: Double }
instance ToJSON Coord where
toJSON (Coord x y) = <code><a href="Data-Yaml.html#v:object">object</a></code> ["x" <code><a href="Data-Yaml.html#v:.-61-">.=</a></code> x, "y" <code><a href="Data-Yaml.html#v:.-61-">.=</a></code> y]
</pre><p>Note the use of the <code>OverloadedStrings</code> language extension which enables
<code>Text</code> values to be written as string literals.
</p><p>Instead of manually writing your <code><a href="Data-Yaml.html#t:ToJSON">ToJSON</a></code> instance, there are three options
to do it automatically:
</p><ul><li> <code><a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson.html#t:TH">TH</a></code> provides template-haskell functions which will derive an
instance at compile-time. The generated instance is optimized for your type
so will probably be more efficient than the following two options:
</li><li> <code><a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson.html#t:Generic">Generic</a></code> provides a generic <code>toJSON</code> function that accepts any
type which is an instance of <code>Data</code>.
</li><li> If your compiler has support for the <code>DeriveGeneric</code> and
<code>DefaultSignatures</code> language extensions, <code>toJSON</code> will have a default generic
implementation.
</li></ul><p>To use the latter option, simply add a <code>deriving <code><a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Generics.html#t:Generic">Generic</a></code></code> clause to your
datatype and declare a <code>ToJSON</code> instance for your datatype without giving a
definition for <code>toJSON</code>.
</p><p>For example the previous example can be simplified to just:
</p><pre>{-# LANGUAGE DeriveGeneric #-}
import GHC.Generics
data Coord { x :: Double, y :: Double } deriving Generic
instance ToJSON Coord
</pre></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:toJSON" class="def">toJSON</a> :: a -> <a href="Data-Yaml.html#t:Value">Value</a></p></div><div class="subs instances"><p id="control.i:ToJSON" class="caption collapser" onclick="toggleSection('i:ToJSON')">Instances</p><div id="section.i:ToJSON" class="show"><table><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Char.html#t:Char">Char</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Double">Double</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Float">Float</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int8">Int8</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int16">Int16</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int32">Int32</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int64">Int64</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Integer">Integer</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Word.html#t:Word">Word</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Word.html#t:Word8">Word8</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Word.html#t:Word16">Word16</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Word.html#t:Word32">Word32</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Word.html#t:Word64">Word64</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> ()</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> Text</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/time-1.4/Data-Time-Clock.html#t:UTCTime">UTCTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#t:DotNetTime">DotNetTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="Data-Yaml.html#t:Value">Value</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/libghc-attoparsec-doc/html/Data-Attoparsec-Number.html#t:Number">Number</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-IntSet.html#t:IntSet">IntSet</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> Text</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Char.html#t:Char">Char</a>]</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> [a]</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Ratio.html#t:Ratio">Ratio</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Integer">Integer</a>)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Dual">Dual</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:First">First</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Last">Last</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-IntMap.html#t:IntMap">IntMap</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-Set.html#t:Set">Set</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashSet.html#t:HashSet">HashSet</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector.html#t:Vector">Vector</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector-Generic.html#t:Vector">Vector</a> <a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector-Unboxed.html#t:Vector">Vector</a> a, <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a) => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector-Unboxed.html#t:Vector">Vector</a> 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/Foreign-Storable.html#t:Storable">Storable</a> a, <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a) => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector-Storable.html#t:Vector">Vector</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector-Primitive-Mutable.html#t:Prim">Prim</a> a, <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a) => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector-Primitive.html#t:Vector">Vector</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a, <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> b) => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Either.html#t:Either">Either</a> a b)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a, <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> b) => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (a, b)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> v => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashMap-Lazy.html#t:HashMap">HashMap</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> v => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashMap-Lazy.html#t:HashMap">HashMap</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> v => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashMap-Lazy.html#t:HashMap">HashMap</a> Text v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> v => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashMap-Lazy.html#t:HashMap">HashMap</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> v => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashMap-Lazy.html#t:HashMap">HashMap</a> Text v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> v => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-Map.html#t:Map">Map</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> v => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-Map.html#t:Map">Map</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> v => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-Map.html#t:Map">Map</a> Text v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> v => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-Map.html#t:Map">Map</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:ToJSON">ToJSON</a> v => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-Map.html#t:Map">Map</a> Text v)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a, <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> b, <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> c) => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (a, b, c)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a, <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> b, <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> c, <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> d) => <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> (a, b, c, d)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:FromJSON" class="def">FromJSON</a> a <span class="keyword">where</span></p><div class="doc"><p>A type that can be converted from JSON, with the possibility of
failure.
</p><p>When writing an instance, use <code>empty</code>, <code>mzero</code>, or <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Monad.html#v:fail">fail</a></code> to make a
conversion fail, e.g. if an <code><a href="Data-Yaml.html#t:Object">Object</a></code> is missing a required key, or
the value is of the wrong type.
</p><p>An example type and instance:
</p><pre>{-# LANGUAGE OverloadedStrings #-}
data Coord { x :: Double, y :: Double }
instance FromJSON Coord where
parseJSON (<code><a href="Data-Yaml.html#t:Object">Object</a></code> v) = Coord <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Functor.html#v:-60--36--62-"><$></a></code>
v <code><a href="Data-Yaml.html#v:.:">.:</a></code> "x" <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Control-Applicative.html#v:-60--42--62-"><*></a></code>
v <code><a href="Data-Yaml.html#v:.:">.:</a></code> "y"
-- A non-<code><a href="Data-Yaml.html#t:Object">Object</a></code> value is of the wrong type, so use <code>mzero</code> to fail.
parseJSON _ = <code>mzero</code>
</pre><p>Note the use of the <code>OverloadedStrings</code> language extension which enables
<code>Text</code> values to be written as string literals.
</p><p>Instead of manually writing your <code><a href="Data-Yaml.html#t:FromJSON">FromJSON</a></code> instance, there are three options
to do it automatically:
</p><ul><li> <code><a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson.html#t:TH">TH</a></code> provides template-haskell functions which will derive an
instance at compile-time. The generated instance is optimized for your type
so will probably be more efficient than the following two options:
</li><li> <code><a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson.html#t:Generic">Generic</a></code> provides a generic <code>fromJSON</code> function that parses to
any type which is an instance of <code>Data</code>.
</li><li> If your compiler has support for the <code>DeriveGeneric</code> and
<code>DefaultSignatures</code> language extensions, <code>parseJSON</code> will have a default
generic implementation.
</li></ul><p>To use this, simply add a <code>deriving <code><a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Generics.html#t:Generic">Generic</a></code></code> clause to your datatype and
declare a <code>FromJSON</code> instance for your datatype without giving a definition
for <code>parseJSON</code>.
</p><p>For example the previous example can be simplified to just:
</p><pre>{-# LANGUAGE DeriveGeneric #-}
import GHC.Generics
data Coord { x :: Double, y :: Double } deriving Generic
instance FromJSON Coord
</pre></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:parseJSON" class="def">parseJSON</a> :: <a href="Data-Yaml.html#t:Value">Value</a> -> <a href="Data-Yaml.html#t:Parser">Parser</a> a</p></div><div class="subs instances"><p id="control.i:FromJSON" class="caption collapser" onclick="toggleSection('i:FromJSON')">Instances</p><div id="section.i:FromJSON" class="show"><table><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Char.html#t:Char">Char</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Double">Double</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Float">Float</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int8">Int8</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int16">Int16</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int32">Int32</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int64">Int64</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Integer">Integer</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Word.html#t:Word">Word</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Word.html#t:Word8">Word8</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Word.html#t:Word16">Word16</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Word.html#t:Word32">Word32</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Word.html#t:Word64">Word64</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> ()</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> Text</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/time-1.4/Data-Time-Clock.html#t:UTCTime">UTCTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/libghc-aeson-doc/html/Data-Aeson-Types.html#t:DotNetTime">DotNetTime</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="Data-Yaml.html#t:Value">Value</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/libghc-attoparsec-doc/html/Data-Attoparsec-Number.html#t:Number">Number</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> <a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-IntSet.html#t:IntSet">IntSet</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> Text</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Char.html#t:Char">Char</a>]</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> [a]</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Ratio.html#t:Ratio">Ratio</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Integer">Integer</a>)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Dual">Dual</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:First">First</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Last">Last</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-IntMap.html#t:IntMap">IntMap</a> 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, <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a) => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-Set.html#t:Set">Set</a> 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, Hashable a, <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a) => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashSet.html#t:HashSet">HashSet</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector.html#t:Vector">Vector</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector-Generic.html#t:Vector">Vector</a> <a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector-Unboxed.html#t:Vector">Vector</a> a, <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a) => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector-Unboxed.html#t:Vector">Vector</a> 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/Foreign-Storable.html#t:Storable">Storable</a> a, <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a) => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector-Storable.html#t:Vector">Vector</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector-Primitive-Mutable.html#t:Prim">Prim</a> a, <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a) => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/libghc-vector-doc/html/Data-Vector-Primitive.html#t:Vector">Vector</a> a)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a, <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> b) => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Either.html#t:Either">Either</a> a b)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a, <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> b) => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (a, b)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> v => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashMap-Lazy.html#t:HashMap">HashMap</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> v => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashMap-Lazy.html#t:HashMap">HashMap</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> v => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashMap-Lazy.html#t:HashMap">HashMap</a> Text v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> v => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashMap-Lazy.html#t:HashMap">HashMap</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> v => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/libghc-unordered-containers-doc/html/Data-HashMap-Lazy.html#t:HashMap">HashMap</a> Text v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> v => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-Map.html#t:Map">Map</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> v => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-Map.html#t:Map">Map</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> v => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-Map.html#t:Map">Map</a> Text v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> v => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-Map.html#t:Map">Map</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> v)</td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Data-Yaml.html#t:FromJSON">FromJSON</a> v => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/containers-0.4.2.1/Data-Map.html#t:Map">Map</a> Text v)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a, <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> b, <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> c) => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (a, b, c)</td><td class="doc empty"> </td></tr><tr><td class="src">(<a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a, <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> b, <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> c, <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> d) => <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> (a, b, c, d)</td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:5">Encoding/decoding
</h1><div class="top"><p class="src"><a name="v:encode" class="def">encode</a> :: <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => a -> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a><a href="src/Data-Yaml.html#encode" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:encodeFile" class="def">encodeFile</a> :: <a href="Data-Yaml.html#t:ToJSON">ToJSON</a> a => <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> a -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <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/Data-Yaml.html#encodeFile" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:decode" class="def">decode</a> :: <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <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/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a<a href="src/Data-Yaml.html#decode" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:decodeFile" class="def">decodeFile</a> :: <a href="Data-Yaml.html#t:FromJSON">FromJSON</a> a => <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/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a)<a href="src/Data-Yaml.html#decodeFile" class="link">Source</a></p></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>
|