Class: YAML::Store

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, PStore
Instance Chain: self, PStore
Inherits:	PStore Object PStore YAML::Store
Defined in:	lib/yaml/store.rb

Overview

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

Example

require 'yaml/store'

Person = Struct.new :first_name, :last_name

people = [Person.new("Bob", "Smith"), Person.new("Mary", "Johnson")]

store = YAML::Store.new "test.store"

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

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

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

Class Method Summary

.new(file_name, yaml_opts = {}) ⇒ Store constructor

Creates a new Store object, which will store data in file_name.

Instance Attribute Summary

#marshal_dump_supports_canonical_option? ⇒ Boolean readonly Internal use only

Instance Method Summary

#dump(table) Internal use only
#empty_marshal_checksum Internal use only
#empty_marshal_data Internal use only
#load(content) Internal use only

Constructor Details

.new(file_name, yaml_opts = {}) ⇒ `Store` .new(file_name, thread_safe = false, yaml_opts = {}) ⇒ `Store`

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

Store objects are always reentrant. But if thread_safe is set to true, then it will become thread-safe at the cost of a minor performance hit.

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

[ GitHub ]

# File 'lib/yaml/store.rb', line 53


def initialize( *o )
  @opt = {}
  if o.last.is_a? Hash
    @opt.update(o.pop)
  end
  super(*o)
end