status-im
/
NimYAML
mirror of https://github.com/status-im/NimYAML.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
NimYAML/yaml.html

106 lines
5.8 KiB
HTML
Raw Permalink Normal View History

First useful gh-pages version (generated)
2016-01-13 21:45:08 +00:00
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>NimYAML - Module yaml</title>
<link href="docutils.css" rel="stylesheet" type="text/css"/>
<link href="style.css" rel="stylesheet" type="text/css"/>
Updated from devel
2016-10-01 13:20:20 +00:00
First useful gh-pages version (generated)
2016-01-13 21:45:08 +00:00
<link href='http://fonts.googleapis.com/css?family=Raleway:400,600,900' rel='stylesheet' type='text/css'/>
<link href='http://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
</head>
<body>
Updated from master
2016-02-25 21:45:48 +00:00
<a href="https://github.com/flyx/NimYAML"><img style="position: fixed; top: 0; right: 0; border: 0; z-index: 10;" src="https://camo.githubusercontent.com/652c5b9acfaddf3a9c326fa6bde407b87f7be0f4/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6f72616e67655f6666373630302e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"></a>
First useful gh-pages version (generated)
2016-01-13 21:45:08 +00:00
<header>
Updated from master
2016-02-25 21:45:48 +00:00
<a class="pagetitle" href="index.html">NimYAML</a>
First useful gh-pages version (generated)
2016-01-13 21:45:08 +00:00
<a href="index.html">Home</a>
<a href="testing.html">Testing Ground</a>
Updated from master
2016-02-15 21:56:36 +00:00
<span>Docs:</span>
Updated from master
2016-02-15 18:51:05 +00:00
<a href="api.html">Overview</a>
Updated from devel
2016-10-01 13:20:20 +00:00
<span>
Updated for 0.8.0
2016-11-08 20:33:08 +00:00
<a href="#">Serialization</a>
Updated from devel
2016-10-01 13:20:20 +00:00
<ul>
Updated for 0.8.0
2016-11-08 20:33:08 +00:00
<li><a href="serialization.html">Overview</a></li>
<li><a href="schema.html">Schema</a></li>
</ul>
</span>
<span>
<a href="#">Modules</a>
<ul class="monospace">
Updated from devel
2016-10-01 13:20:20 +00:00
<li><a href="yaml.html">yaml</a></li>
<li><a href="yaml.dom.html">yaml.dom</a></li>
<li><a href="yaml.hints.html">yaml.hints</a></li>
<li><a href="yaml.parser.html">yaml.parser</a></li>
<li><a href="yaml.presenter.html">yaml.presenter</a></li>
<li><a href="yaml.serialization.html">yaml.serialization</a></li>
<li><a href="yaml.stream.html">yaml.stream</a></li>
<li><a href="yaml.taglib.html">yaml.taglib</a></li>
<li><a href="yaml.tojson.html">yaml.tojson</a></li>
</ul>
</span>
First useful gh-pages version (generated)
2016-01-13 21:45:08 +00:00
</header>
<article id="documentId">
<div class="container">
<h1 class="title">Module yaml</h1>
<div class="row">
<div class="three columns">
Updated from devel
2016-10-01 13:20:20 +00:00
<div>
Search: <input type="text" id="searchInput"
onkeyup="search()" />
</div>
<div>
Group by:
<select onchange="groupBy(this.value)">
<option value="section">Section</option>
<option value="type">Type</option>
</select>
</div>
First useful gh-pages version (generated)
2016-01-13 21:45:08 +00:00
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
</ul>
</div>
<div class="nine columns" id="content">
Updated from devel
2016-10-01 13:20:20 +00:00
<div id="tocRoot"></div>
<p class="module-desc"><p>This is the parent module of NimYAML, a package that provides facilities to generate and interpret <a class="reference external" href="http://yaml.org">YAML</a> character streams. Importing this package will import everything from all subpackages.</p>
<p>There are three high-level APIs which are probably most useful:</p>
<ul class="simple"><li>The serialization API in <a class="reference external" href="yaml.serialization.html">serialization</a> enables you to load YAML data directly into native Nim types, and reversely dump native Nim types as YAML.</li>
<li>The DOM API in <a class="reference external" href="yaml.dom.html">dom</a> parses YAML files in a tree structure which you can navigate.</li>
<li>The JSON API in <a class="reference external" href="yaml.tojson.html">tojson</a> parses YAML files into the Nim stdlib's JSON structure, which may be useful if you have other modules which expect JSON input. Note that the serialization API is able to write and load JSON; you do not need the JSON API for that.</li>
</ul>
<p>Apart from those high-level APIs, NimYAML implements a low-level API which enables you to process YAML input as data stream which does not need to be loaded into RAM completely at once. It consists of the following modules:</p>
<ul class="simple"><li>The stream API in <a class="reference external" href="yaml.stream.html">stream</a> defines the central type for stream processing, <tt class="docutils literal"><span class="pre">YamlStream</span></tt>. It also contains definitions and constructor procs for stream events.</li>
<li>The parser API in <a class="reference external" href="yaml.parser.html">parser</a> gives you direct access to the YAML parser's output.</li>
<li>The presenter API in <a class="reference external" href="yaml/presenter.html">presenter</a> gives you direct access to the presenter, i.e. the module that renders a YAML character stream.</li>
<li>The taglib API in <a class="reference external" href="yaml.taglib.html">taglib</a> provides a data structure for keeping track of YAML tags that are generated by the parser or used in the presenter.</li>
<li>The hints API in <a class="reference external" href="yaml.hints.html">hints</a> provides a simple proc for guessing the type of a scalar value.</li>
</ul>
First useful gh-pages version (generated)
2016-01-13 21:45:08 +00:00
</p>
<section id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
Updated from devel
2016-10-01 13:20:20 +00:00
<a class="reference external" href="yaml/dom.html">yaml/dom</a>, <a class="reference external" href="yaml/hints.html">yaml/hints</a>, <a class="reference external" href="yaml/parser.html">yaml/parser</a>, <a class="reference external" href="yaml/presenter.html">yaml/presenter</a>, <a class="reference external" href="yaml/serialization.html">yaml/serialization</a>, <a class="reference external" href="yaml/stream.html">yaml/stream</a>, <a class="reference external" href="yaml/taglib.html">yaml/taglib</a>, <a class="reference external" href="yaml/tojson.html">yaml/tojson</a>
First useful gh-pages version (generated)
2016-01-13 21:45:08 +00:00
</dl></section>
</div>
</div>
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
updated from devel
2017-09-20 17:10:05 +00:00
<small>Made with Nim. Generated: 2017-09-20 19:08:34 UTC</small>
First useful gh-pages version (generated)
2016-01-13 21:45:08 +00:00
</div>
</div>
</div>
</article>
</body>
</html>