File: C:/Ruby27-x64/share/doc/ruby/html/YAML/Store.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class YAML::Store - 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="../PStore.html">PStore</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>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-YAML::Store">
<h1 id="class-YAML::Store" class="class">
class YAML::Store
</h1>
<section class="description">
<p><a href="Store.html"><code>YAML::Store</code></a> provides the same functionality as <a href="../PStore.html"><code>PStore</code></a>, except it uses YAML to dump objects instead of <a href="../Marshal.html"><code>Marshal</code></a>.</p>
<h2 id="class-YAML::Store-label-Example">Example<span><a href="#class-YAML::Store-label-Example">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'yaml/store'</span>
<span class="ruby-constant">Person</span> = <span class="ruby-constant">Struct</span>.<span class="ruby-identifier">new</span> <span class="ruby-value">:first_name</span>, <span class="ruby-value">:last_name</span>
<span class="ruby-identifier">people</span> = [<span class="ruby-constant">Person</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"Bob"</span>, <span class="ruby-string">"Smith"</span>), <span class="ruby-constant">Person</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"Mary"</span>, <span class="ruby-string">"Johnson"</span>)]
<span class="ruby-identifier">store</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-constant">Store</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">"test.store"</span>
<span class="ruby-identifier">store</span>.<span class="ruby-identifier">transaction</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">store</span>[<span class="ruby-string">"people"</span>] = <span class="ruby-identifier">people</span>
<span class="ruby-identifier">store</span>[<span class="ruby-string">"greeting"</span>] = { <span class="ruby-string">"hello"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"world"</span> }
<span class="ruby-keyword">end</span>
</pre>
<p>After running the above code, the contents of “test.store” will be:</p>
<pre>---
people:
- !ruby/struct:Person
first_name: Bob
last_name: Smith
- !ruby/struct:Person
first_name: Mary
last_name: Johnson
greeting:
hello: world</pre>
</section>
<section id="5Buntitled-5D" class="documentation-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-callseq">
initialize( file_name, yaml_opts = {} )
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
initialize( file_name, thread_safe = false, yaml_opts = {} )
</span>
</div>
<div class="method-description">
<p>Creates a new <a href="Store.html"><code>YAML::Store</code></a> object, which will store data in <code>file_name</code>. If the file does not already exist, it will be created.</p>
<p><a href="Store.html"><code>YAML::Store</code></a> objects are always reentrant. But if <em>thread_safe</em> is set to true, then it will become thread-safe at the cost of a minor performance hit.</p>
<p>Options passed in through <code>yaml_opts</code> will be used when converting the store to YAML via <a href="../Object.html#method-i-to_yaml"><code>Hash#to_yaml()</code></a>.</p>
<div class="method-calls-super">
Calls superclass method
<a href="../PStore.html#method-c-new"><code>PStore::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/yaml/store.rb, line 53</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">o</span> )
<span class="ruby-ivar">@opt</span> = {}
<span class="ruby-keyword">if</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Hash</span>
<span class="ruby-ivar">@opt</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">o</span>.<span class="ruby-identifier">pop</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">super</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">o</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>