File: C:/Ruby27-x64/share/doc/ruby/html/Psych/Nodes/Document.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Psych::Nodes::Document - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Node.html">Psych::Nodes::Node</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-document-3F">#document?</a>
<li ><a href="#method-i-root">#root</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Psych::Nodes::Document">
<h1 id="class-Psych::Nodes::Document" class="class">
class Psych::Nodes::Document
</h1>
<section class="description">
<p>This represents a YAML <a href="Document.html"><code>Document</code></a>. This node must be a child of <a href="Stream.html"><code>Psych::Nodes::Stream</code></a>. A <a href="Document.html"><code>Psych::Nodes::Document</code></a> must have one child, and that child may be one of the following:</p>
<ul><li>
<p><a href="Sequence.html"><code>Psych::Nodes::Sequence</code></a></p>
</li><li>
<p><a href="Mapping.html"><code>Psych::Nodes::Mapping</code></a></p>
</li><li>
<p><a href="Scalar.html"><code>Psych::Nodes::Scalar</code></a></p>
</li></ul>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-implicit" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">implicit</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Was this document implicitly created?</p>
</div>
</div>
<div id="attribute-i-implicit_end" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">implicit_end</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Is the end of the document implicit?</p>
</div>
</div>
<div id="attribute-i-tag_directives" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">tag_directives</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>A list of tag directives for this document</p>
</div>
</div>
<div id="attribute-i-version" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">version</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The version of the YAML document</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(version = [], tag_directives = [], implicit = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a new <a href="Document.html"><code>Psych::Nodes::Document</code></a> object.</p>
<p><code>version</code> is a list indicating the YAML version. <code>tags_directives</code> is a list of tag directive declarations <code>implicit</code> is a flag indicating whether the document will be implicitly started.</p>
<h2 id="method-c-new-label-Example-3A">Example:<span><a href="#method-c-new-label-Example-3A">¶</a> <a href="#top">↑</a></span></h2>
<p>This creates a YAML document object that represents a YAML 1.1 document with one tag directive, and has an implicit start:</p>
<pre class="ruby"><span class="ruby-constant">Psych</span><span class="ruby-operator">::</span><span class="ruby-constant">Nodes</span><span class="ruby-operator">::</span><span class="ruby-constant">Document</span>.<span class="ruby-identifier">new</span>(
[<span class="ruby-value">1</span>,<span class="ruby-value">1</span>],
[[<span class="ruby-string">"!"</span>, <span class="ruby-string">"tag:tenderlovemaking.com,2009:"</span>]],
<span class="ruby-keyword">true</span>
)
</pre>
<h2 id="method-c-new-label-See+Also">See Also<span><a href="#method-c-new-label-See+Also">¶</a> <a href="#top">↑</a></span></h2>
<p>See also <a href="../Handler.html#method-i-start_document"><code>Psych::Handler#start_document</code></a></p>
<div class="method-calls-super">
Calls superclass method
<a href="Node.html#method-c-new"><code>Psych::Nodes::Node::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/nodes/document.rb, line 45</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span> <span class="ruby-identifier">version</span> = [], <span class="ruby-identifier">tag_directives</span> = [], <span class="ruby-identifier">implicit</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">super</span>()
<span class="ruby-ivar">@version</span> = <span class="ruby-identifier">version</span>
<span class="ruby-ivar">@tag_directives</span> = <span class="ruby-identifier">tag_directives</span>
<span class="ruby-ivar">@implicit</span> = <span class="ruby-identifier">implicit</span>
<span class="ruby-ivar">@implicit_end</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-document-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">document?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="document-3F-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/nodes/document.rb, line 60</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">document?</span>; <span class="ruby-keyword">true</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-root" class="method-detail ">
<div class="method-heading">
<span class="method-name">root</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the root node. A <a href="Document.html"><code>Document</code></a> may only have one root node: <a href="http://yaml.org/spec/1.1/#id898031">yaml.org/spec/1.1/#id898031</a></p>
<div class="method-source-code" id="root-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/nodes/document.rb, line 56</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">root</span>
<span class="ruby-identifier">children</span>.<span class="ruby-identifier">first</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>