Maintenance of Ruby 2.0.0 ended on February 24, 2016. Read more

In Files

  • yaml/store.rb



Class/Module Index [+]



YAML::Store provides the same functionality as PStore, except it uses YAML to dump objects instead of Marshal.


require 'yaml/store'

Person = :first_name, :last_name

people = ["Bob", "Smith"),"Mary", "Johnson")]

store = ""

store.transaction do
  store["people"] = people
  store["greeting"] = { "hello" => "world" }

After running the above code, the contents of “” will be:

- !ruby/struct:Person
  first_name: Bob
  last_name: Smith
- !ruby/struct:Person
  first_name: Mary
  last_name: Johnson
  hello: world

Public Class Methods

initialize( file_name, yaml_opts = {} ) click to toggle source

Creates a new YAML::Store object, which will store data in file_name. If the file does not already exist, it will be created.

Options passed in through yaml_opts will be used when converting the store to YAML via Hash#to_yaml().

               # File yaml/store.rb, line 49
def initialize file_name, yaml_opts = {}
  @opt = yaml_opts

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit