singleton method Psych.dump

dump(o, options = {}) -> String[permalink][rdoc]

dump(o, io, options = {}) -> ()

Ruby のオブジェクト o を YAML ドキュメントに変換します。

io に IO オブジェクトを指定した場合は、変換されたドキュメントがその IO に書き込まれます。指定しなかった場合は変換されたドキュメントが文字列としてメソッドの返り値となります。

options で出力に関するオプションを以下の指定できます。

:version: YAML document に付加するバージョンを [major, minor] という配列、もしくは文字列で指定します
:header: 出力にヘッダを付けるかどうかを真偽値で指定します
:indentation: インデントのレベルを 1 から 9 までの整数で指定します
:canonical: 出力の style が canonical であるかどうかを真偽値で指定します
:line_width: 「好ましい」行幅を整数値で指定します

[PARAM] o:: 変換するオブジェクト
[PARAM] io:: 出力先
[PARAM] options:: 出力オプション

例

# Dump an array, get back a YAML string
Psych.dump(['a', 'b'])  # => "---\n- a\n- b\n"

# Dump an array to an IO object
Psych.dump(['a', 'b'], StringIO.new)  # => #<StringIO:0x000001009d0890>

# Dump an array with indentation set
Psych.dump(['a', ['b']], :indentation => 3) # => "---\n- a\n-  - b\n"

# Dump an array to an IO with indentation set
Psych.dump(['a', ['b']], StringIO.new, :indentation => 3)