class Psych::Stream

クラス・モジュールの継承リスト: Psych::Stream < Psych::Visitors::YAMLTree < Psych::Visitors::Visitor < Object < Kernel < BasicObject

要約

入力されたオブジェクトから変換された YAML document を指定した IO に出力する機能を持つクラスです。

start で変換を開始し、push で変換する Ruby オブジェクトを渡し、最後に finish を呼ぶことで変換を完了します。

stream = Psych::Stream.new($stdout)
stream.start
stream.push({:foo => 'bar'})
stream.finish

YAML document は(バッファリングされずに)直接 $stdout に出力されます。

finish を確実に呼び出すためには Psych::Stream#start メソッドをブロック付きで呼び出すとよいでしょう。

stream = Psych::Stream.new($stdout)
stream.start do |em|
  em.push(:foo => 'bar')
end

基本的な仕組みは Psych::Visitors::YAMLTree と似ています。

定義	説明
`new(io) -> Psych::Stream`	新たな Stream オブジェクトを生成します。

定義	説明
`finish -> ()`	YAML document への変換を完了し、io への出力を完了します。
`start(encoding = Psych::Nodes::Stream::UTF8) -> Psych::Stream start(encoding = Psych::Nodes::Stream::UTF8) {\|em\| ... } -> Psych::Stream`	Ruby オブジェクトを YAML document に変換するための準備をします。