Ruby Psych.safe_dump用法及代碼示例

safe_dump(o) → string of yaml

safe_dump(o, options) → string of yaml

safe_dump(o, io) → io object passed in

safe_dump(o, io, options) → io object passed in

安全地將 Ruby 對象 o 轉儲到 YAML 字符串。可以傳入可選的options 來控製輸出格式。如果傳入 IO 對象，則 YAML 將轉儲到該 IO 對象。默認情況下，隻允許序列化以下類：

• TrueClass

• FalseClass

• NilClass

• Integer

• Float

• String

• Array

• Hash

可以通過將這些類添加到permitted_classes 關鍵字參數來允許任意類。它們是添加劑。例如，要允許 Date 序列化：

Psych.safe_dump(yaml, permitted_classes: [Date])

現在除了上麵列出的類之外，還可以轉儲 Date 類。

如果對象包含不在 permitted_classes 列表中的類，則會引發 Psych::DisallowedClass 異常。

目前支持的選項有：

:indentation

用於縮進的空格字符數。可接受的值應在0..9 範圍內，否則忽略選項。

默認值：2。

:line_width

換行的最大字符。

默認值：0(意思是“在 81 處換行”)。

:canonical

編寫“canonical” YAML 形式(非常冗長，但嚴格正式)。

默認值：false。

:header

在文檔開頭寫上%YAML [version]。

默認值：false。

例子：

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

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

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

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