File: C:/Ruby27-x64/share/doc/ruby/html/Psych/Coder.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Psych::Coder - 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>
<!-- 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-5B-5D">#[]</a>
<li ><a href="#method-i-5B-5D-3D">#[]=</a>
<li ><a href="#method-i-add">#add</a>
<li ><a href="#method-i-map">#map</a>
<li ><a href="#method-i-map-3D">#map=</a>
<li ><a href="#method-i-represent_map">#represent_map</a>
<li ><a href="#method-i-represent_object">#represent_object</a>
<li ><a href="#method-i-represent_scalar">#represent_scalar</a>
<li ><a href="#method-i-represent_seq">#represent_seq</a>
<li ><a href="#method-i-scalar">#scalar</a>
<li ><a href="#method-i-scalar-3D">#scalar=</a>
<li ><a href="#method-i-seq-3D">#seq=</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Psych::Coder">
<h1 id="class-Psych::Coder" class="class">
class Psych::Coder
</h1>
<section class="description">
<p>If an object defines <code>encode_with</code>, then an instance of <a href="Coder.html"><code>Psych::Coder</code></a> will be passed to the method when the object is being serialized. The <a href="Coder.html"><code>Coder</code></a> automatically assumes a <a href="Nodes/Mapping.html"><code>Psych::Nodes::Mapping</code></a> is being emitted. Other objects like Sequence and Scalar may be emitted if <code>seq=</code> or <code>scalar=</code> are called, respectively.</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-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">
</div>
</div>
<div id="attribute-i-object" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">object</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-seq" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">seq</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-style" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">style</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
</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">[RW]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-type" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">type</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</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">(tag)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/coder.rb, line 13</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span> <span class="ruby-identifier">tag</span>
<span class="ruby-ivar">@map</span> = {}
<span class="ruby-ivar">@seq</span> = []
<span class="ruby-ivar">@implicit</span> = <span class="ruby-keyword">false</span>
<span class="ruby-ivar">@type</span> = <span class="ruby-value">:map</span>
<span class="ruby-ivar">@tag</span> = <span class="ruby-identifier">tag</span>
<span class="ruby-ivar">@style</span> = <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">Mapping</span><span class="ruby-operator">::</span><span class="ruby-constant">BLOCK</span>
<span class="ruby-ivar">@scalar</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@object</span> = <span class="ruby-keyword">nil</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-5B-5D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]</span><span
class="method-args">(k)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/coder.rb, line 84</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span> <span class="ruby-identifier">k</span>
<span class="ruby-ivar">@type</span> = <span class="ruby-value">:map</span>
<span class="ruby-ivar">@map</span>[<span class="ruby-identifier">k</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-5B-5D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]=</span><span
class="method-args">(k, v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="5B-5D-3D-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/coder.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]=</span> <span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>
<span class="ruby-ivar">@type</span> = <span class="ruby-value">:map</span>
<span class="ruby-ivar">@map</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Coder.html#method-i-add">add</a>
</div>
</div>
<div id="method-i-add" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">add</span><span
class="method-args">(k, v)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Coder.html#method-i-5B-5D-3D">[]=</a>
</div>
</div>
<div id="method-i-map" class="method-detail ">
<div class="method-heading">
<span class="method-name">map</span><span
class="method-args">(tag = @tag, style = @style) { |self| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Emit a map. The coder will be yielded to the block.</p>
<div class="method-source-code" id="map-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/coder.rb, line 34</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">map</span> <span class="ruby-identifier">tag</span> = <span class="ruby-ivar">@tag</span>, <span class="ruby-identifier">style</span> = <span class="ruby-ivar">@style</span>
<span class="ruby-ivar">@tag</span> = <span class="ruby-identifier">tag</span>
<span class="ruby-ivar">@style</span> = <span class="ruby-identifier">style</span>
<span class="ruby-keyword">yield</span> <span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-ivar">@map</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-map-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">map=</span><span
class="method-args">(map)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Emit a map with <code>value</code></p>
<div class="method-source-code" id="map-3D-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/coder.rb, line 73</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">map=</span> <span class="ruby-identifier">map</span>
<span class="ruby-ivar">@type</span> = <span class="ruby-value">:map</span>
<span class="ruby-ivar">@map</span> = <span class="ruby-identifier">map</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-represent_map" class="method-detail ">
<div class="method-heading">
<span class="method-name">represent_map</span><span
class="method-args">(tag, map)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Emit a sequence with <code>map</code> and <code>tag</code></p>
<div class="method-source-code" id="represent_map-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/coder.rb, line 54</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">represent_map</span> <span class="ruby-identifier">tag</span>, <span class="ruby-identifier">map</span>
<span class="ruby-ivar">@tag</span> = <span class="ruby-identifier">tag</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">map</span> = <span class="ruby-identifier">map</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-represent_object" class="method-detail ">
<div class="method-heading">
<span class="method-name">represent_object</span><span
class="method-args">(tag, obj)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Emit an arbitrary object <code>obj</code> and <code>tag</code></p>
<div class="method-source-code" id="represent_object-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/coder.rb, line 60</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">represent_object</span> <span class="ruby-identifier">tag</span>, <span class="ruby-identifier">obj</span>
<span class="ruby-ivar">@tag</span> = <span class="ruby-identifier">tag</span>
<span class="ruby-ivar">@type</span> = <span class="ruby-value">:object</span>
<span class="ruby-ivar">@object</span> = <span class="ruby-identifier">obj</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-represent_scalar" class="method-detail ">
<div class="method-heading">
<span class="method-name">represent_scalar</span><span
class="method-args">(tag, value)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Emit a scalar with <code>value</code> and <code>tag</code></p>
<div class="method-source-code" id="represent_scalar-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/coder.rb, line 42</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">represent_scalar</span> <span class="ruby-identifier">tag</span>, <span class="ruby-identifier">value</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">tag</span> = <span class="ruby-identifier">tag</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">scalar</span> = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-represent_seq" class="method-detail ">
<div class="method-heading">
<span class="method-name">represent_seq</span><span
class="method-args">(tag, list)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Emit a sequence with <code>list</code> and <code>tag</code></p>
<div class="method-source-code" id="represent_seq-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/coder.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">represent_seq</span> <span class="ruby-identifier">tag</span>, <span class="ruby-identifier">list</span>
<span class="ruby-ivar">@tag</span> = <span class="ruby-identifier">tag</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">seq</span> = <span class="ruby-identifier">list</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-scalar" class="method-detail ">
<div class="method-heading">
<span class="method-name">scalar</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="scalar-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/coder.rb, line 24</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">scalar</span> <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-identifier">warn</span> <span class="ruby-node">"#{caller[0]}: Coder#scalar(a,b,c) is deprecated"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">$VERBOSE</span>
<span class="ruby-ivar">@tag</span>, <span class="ruby-ivar">@scalar</span>, <span class="ruby-identifier">_</span> = <span class="ruby-identifier">args</span>
<span class="ruby-ivar">@type</span> = <span class="ruby-value">:scalar</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@scalar</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-scalar-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">scalar=</span><span
class="method-args">(value)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Emit a scalar with <code>value</code></p>
<div class="method-source-code" id="scalar-3D-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/coder.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">scalar=</span> <span class="ruby-identifier">value</span>
<span class="ruby-ivar">@type</span> = <span class="ruby-value">:scalar</span>
<span class="ruby-ivar">@scalar</span> = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-seq-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">seq=</span><span
class="method-args">(list)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Emit a sequence of <code>list</code></p>
<div class="method-source-code" id="seq-3D-source">
<pre><span class="ruby-comment"># File ext/psych/lib/psych/coder.rb, line 90</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">seq=</span> <span class="ruby-identifier">list</span>
<span class="ruby-ivar">@type</span> = <span class="ruby-value">:seq</span>
<span class="ruby-ivar">@seq</span> = <span class="ruby-identifier">list</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>