Class: YAML::Store
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
PStore
|
|
Instance Chain:
self,
PStore
|
|
Inherits: |
PStore
|
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 infile_name
.
Constructor Details
.new(file_name, 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.
Options passed in through yaml_opts
will be used when converting the store to YAML via Hash#to_yaml().
# File 'lib/yaml/store.rb', line 50
def initialize file_name, yaml_opts = {} @opt = yaml_opts super end