File: C:/Ruby27-x64/share/doc/ruby/html/Psych/Stream.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Psych::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="Visitors/YAMLTree.html">Psych::Visitors::YAMLTree</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="Streaming.html">Psych::Streaming</a>
</ul>
</div>
<div id="extends-section" class="nav-section">
<h3>Extended With Modules</h3>
<ul class="link-list">
<li><a class="extend" href="Streaming/ClassMethods.html">Psych::Streaming::ClassMethods</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Psych::Stream">
<h1 id="class-Psych::Stream" class="class">
class Psych::Stream
</h1>
<section class="description">
<p><a href="Stream.html"><code>Psych::Stream</code></a> is a streaming YAML emitter. It will not buffer your YAML, but send it straight to an <a href="../IO.html"><code>IO</code></a>.</p>
<p>Here is an example use:</p>
<pre class="ruby"><span class="ruby-identifier">stream</span> = <span class="ruby-constant">Psych</span><span class="ruby-operator">::</span><span class="ruby-constant">Stream</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">$stdout</span>)
<span class="ruby-identifier">stream</span>.<span class="ruby-identifier">start</span>
<span class="ruby-identifier">stream</span>.<span class="ruby-identifier">push</span>({<span class="ruby-value">:foo</span> <span class="ruby-operator">=></span> <span class="ruby-string">'bar'</span>})
<span class="ruby-identifier">stream</span>.<span class="ruby-identifier">finish</span>
</pre>
<p>YAML will be immediately emitted to $stdout with no buffering.</p>
<p><a href="Streaming.html#method-i-start"><code>Psych::Stream#start</code></a> will take a block and ensure that <a href="Visitors/YAMLTree.html#method-i-finish"><code>Psych::Stream#finish</code></a> is called, so you can do this form:</p>
<pre class="ruby"><span class="ruby-identifier">stream</span> = <span class="ruby-constant">Psych</span><span class="ruby-operator">::</span><span class="ruby-constant">Stream</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">$stdout</span>)
<span class="ruby-identifier">stream</span>.<span class="ruby-identifier">start</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">em</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">em</span>.<span class="ruby-identifier">push</span>(<span class="ruby-value">:foo</span> <span class="ruby-operator">=></span> <span class="ruby-string">'bar'</span>)
<span class="ruby-keyword">end</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-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>