File: C:/Ruby27-x64/share/doc/ruby/html/Psych/Nodes/Node.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Psych::Nodes::Node - 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="../../Object.html">Object</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../../Enumerable.html">Enumerable</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-alias-3F">#alias?</a>
<li ><a href="#method-i-document-3F">#document?</a>
<li ><a href="#method-i-each">#each</a>
<li ><a href="#method-i-mapping-3F">#mapping?</a>
<li ><a href="#method-i-scalar-3F">#scalar?</a>
<li ><a href="#method-i-sequence-3F">#sequence?</a>
<li ><a href="#method-i-stream-3F">#stream?</a>
<li ><a href="#method-i-to_ruby">#to_ruby</a>
<li ><a href="#method-i-to_yaml">#to_yaml</a>
<li ><a href="#method-i-transform">#transform</a>
<li ><a href="#method-i-yaml">#yaml</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Psych::Nodes::Node">
<h1 id="class-Psych::Nodes::Node" class="class">
class Psych::Nodes::Node
</h1>
<section class="description">
<p>The base class for any <a href="Node.html"><code>Node</code></a> in a YAML parse tree. This class should never be instantiated.</p>
</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-children" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">children</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The children of this node</p>
</div>
</div>
<div id="attribute-i-end_column" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">end_column</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The column number where this node ends</p>
</div>
</div>
<div id="attribute-i-end_line" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">end_line</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The line number where this node ends</p>
</div>
</div>
<div id="attribute-i-start_column" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">start_column</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The column number where this node start</p>
</div>
</div>
<div id="attribute-i-start_line" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">start_line</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The line number where this node start</p>
</div>
</div>
<div id="attribute-i-tag" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">tag</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>An associated tag</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">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a new <a href="Node.html"><code>Psych::Nodes::Node</code></a></p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/nodes/node.rb, line 33</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-ivar">@children</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-alias-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">alias?</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="alias-3F-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/nodes/node.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">alias?</span>; <span class="ruby-keyword">false</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<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/node.rb, line 68</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">document?</span>; <span class="ruby-keyword">false</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each" class="method-detail ">
<div class="method-heading">
<span class="method-name">each</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Iterate over each node in the tree. Yields each node to <code>block</code> depth first.</p>
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/nodes/node.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span> <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span> <span class="ruby-value">:each</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-constant">Visitors</span><span class="ruby-operator">::</span><span class="ruby-constant">DepthFirst</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">block</span>).<span class="ruby-identifier">accept</span> <span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mapping-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">mapping?</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="mapping-3F-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/nodes/node.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mapping?</span>; <span class="ruby-keyword">false</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-scalar-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">scalar?</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="scalar-3F-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/nodes/node.rb, line 70</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">scalar?</span>; <span class="ruby-keyword">false</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sequence-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">sequence?</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="sequence-3F-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/nodes/node.rb, line 71</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sequence?</span>; <span class="ruby-keyword">false</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-stream-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">stream?</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="stream-3F-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/nodes/node.rb, line 72</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">stream?</span>; <span class="ruby-keyword">false</span>; <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_ruby" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_ruby</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert this node to Ruby.</p>
<p>See also <a href="../Visitors/ToRuby.html"><code>Psych::Visitors::ToRuby</code></a></p>
<div class="method-source-code" id="to_ruby-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/nodes/node.rb, line 49</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_ruby</span>
<span class="ruby-constant">Visitors</span><span class="ruby-operator">::</span><span class="ruby-constant">ToRuby</span>.<span class="ruby-identifier">create</span>.<span class="ruby-identifier">accept</span>(<span class="ruby-keyword">self</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Node.html#method-i-transform">transform</a>
</div>
</div>
<div id="method-i-to_yaml" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">to_yaml</span><span
class="method-args">(io = nil, options = {})</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Node.html#method-i-yaml">yaml</a>
</div>
</div>
<div id="method-i-transform" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">transform</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Node.html#method-i-to_ruby">to_ruby</a>
</div>
</div>
<div id="method-i-yaml" class="method-detail ">
<div class="method-heading">
<span class="method-name">yaml</span><span
class="method-args">(io = nil, options = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert this node to YAML.</p>
<p>See also <a href="../Visitors/Emitter.html"><code>Psych::Visitors::Emitter</code></a></p>
<div class="method-source-code" id="yaml-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/nodes/node.rb, line 58</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">yaml</span> <span class="ruby-identifier">io</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span> = {}
<span class="ruby-identifier">real_io</span> = <span class="ruby-identifier">io</span> <span class="ruby-operator">||</span> <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">''</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-string">'utf-8'</span>))
<span class="ruby-constant">Visitors</span><span class="ruby-operator">::</span><span class="ruby-constant">Emitter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">real_io</span>, <span class="ruby-identifier">options</span>).<span class="ruby-identifier">accept</span> <span class="ruby-keyword">self</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">real_io</span>.<span class="ruby-identifier">string</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">io</span>
<span class="ruby-identifier">io</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Node.html#method-i-to_yaml">to_yaml</a>
</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>