File: C:/Ruby27-x64/share/doc/ruby/html/Psych/Nodes/Stream.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Psych::Nodes::Stream - 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-stream-3F">#stream?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Psych::Nodes::Stream">
<h1 id="class-Psych::Nodes::Stream" class="class">
class Psych::Nodes::Stream
</h1>
<section class="description">
<p>Represents a YAML stream. This is the root node for any YAML parse tree. This node must have one or more child nodes. The only valid child node for a <a href="Stream.html"><code>Psych::Nodes::Stream</code></a> node is <a href="Document.html"><code>Psych::Nodes::Document</code></a>.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ANY">ANY
<dd><p>Any encoding</p>
<dt id="UTF16BE">UTF16BE
<dd><p>UTF-16BE encoding</p>
<dt id="UTF16LE">UTF16LE
<dd><p>UTF-16LE encoding</p>
<dt id="UTF8">UTF8
<dd><p>UTF-8 encoding</p>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-encoding" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">encoding</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The encoding used for this stream</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">(encoding = UTF8)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a new <a href="Stream.html"><code>Psych::Nodes::Stream</code></a> node with an <code>encoding</code> that defaults to <a href="Stream.html#UTF8"><code>Psych::Nodes::Stream::UTF8</code></a>.</p>
<p>See also <a href="../Handler.html#method-i-start_stream"><code>Psych::Handler#start_stream</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/stream.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span> <span class="ruby-identifier">encoding</span> = <span class="ruby-constant">UTF8</span>
<span class="ruby-keyword">super</span>()
<span class="ruby-ivar">@encoding</span> = <span class="ruby-identifier">encoding</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-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/stream.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">stream?</span>; <span class="ruby-keyword">true</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>