バージョン:2.3.0 > クエリ:IO > ライブラリ:psych

...[例][ruby]{
# 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)
//}...

Psych.dump(o, options = {}) -> String (418.0)

2.3.0

特異メソッド

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

...a\n- - b\n"

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

Psych::Stream.new(io) -> Psych::Stream (364.0)

2.3.0

特異メソッド

新たな Stream オブジェクトを生成します。

新たな Stream オブジェクトを生成します。

io で YAML document の出力先を指定します。

@param io 出力先の IO オブジェクト

Psych::Emitter.new(io) -> Psych::Emitter (346.0)

2.3.0

特異メソッド

Emitter オブジェクトを生成して返します。

Emitter オブジェクトを生成して返します。

@param io 出力先の IO オブジェクト

Object#psych_to_yaml(options = {}) -> String (307.0)

2.3.0

インスタンスメソッド

オブジェクトを YAML document に変換します。

...ョンを指定できます。
Psych.dump と同じなので詳しくはそちらを参照してください。

syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予...

...定であるため、特別の事情がない限り to_yaml を用いてください。

@param options 出力オプション
@see Psych.dump...

絞り込み条件を変える

Object#to_yaml(options = {}) -> String (307.0)

2.3.0

インスタンスメソッド

オブジェクトを YAML document に変換します。

...定であるため、特別の事情がない限り to_yaml を用いてください。

@param options 出力オプション
@see Psych.dump...

Psych::Handler#start_document(version, tag_directives, implicit) -> () (307.0)

2.3.0

インスタンスメソッド

YAML ドキュメントの始まりで呼び出されます。

YAML ドキュメントの始まりで呼び出されます。

version には YAML ドキュメントに宣言されているバージョンが
[major, minor] という配列で渡されます。宣言がない場合は空の配列が渡されます。

tag_directives には tag directive の配列が渡されます。
それぞれの tag は [prefix, suffix] という配列で表現されます。

implicit にはドキュメントが implicit に始まっているかどうかが
真偽値で渡されます。

必要に応じてこのメソッドを override してください。

@param version ...

Psych::Nodes::Document.new(version=[], tag_directives=[], implicit=false) -> Psych::Nodes::Document (307.0)

2.3.0

特異メソッド

Document オブジェクトを生成します。

...YAML 1.1 のドキュメントで、
tag directive を1つ持ち、 implicit にドキュメントが開始
している Document オブジェクトを生成しています。

Psych::Nodes::Document.new(
[1,1],
tenderlovemaking.com,2009:",
true)

@see Psych::Handler#start_document...

Psych::Visitors::YAMLTree.new(options = {}, emitter = Psych::TreeBuilder.new, ss = Psych::ScalarScanner.new) -> Psych::Visitors::YAMLTree (307.0)

2.3.0

特異メソッド

YAMLTree オブジェクトを生成します。

...定します。
Psych.dump と同じオプションが指定できます。

emitter には AST の構築に使われる Psych::TreeBuilder オブジェクト
を渡します。

ss は Ruby の String が YAML document 上で quote が必要かどうか
を判定するための Psych::ScalarScanner...

...常デフォルトのものから変える必要はないでしょう。

@param options オプション
@param emitter AST の構築に使う Psych::TreeBuilder オブジェクト
@param ss 文字列に quite が必要かどうかを判定するための Psych::ScalarScanner オブジェクト...

Psych::Stream (55.0)

2.3.0

クラス

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

...を完了します。
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 と似ています。...

絞り込み条件を変える

Psych::Stream#finish -> () (55.0)

2.3.0

インスタンスメソッド

YAML document への変換を完了し、io への出力を完了します。

Psych.safe_load(yaml, whitelist_classes = [], whitelist_symbols = [], aliases = false, filename = nil) -> object (43.0)

2.3.0

特異メソッド

安全に YAML フォーマットの文書を読み込み Ruby のオブジェクトを生成して返します。

...[ruby]{
Psych.safe_load(yaml, [Date])
//}

すると上のクラス一覧に加えて Date クラスが読み込まれます。

エイリアスは aliases パラメーターを変更することで明示的に許可できます。

//emlist[例][ruby]{
x = []
x << x
yaml = Psych.dump x
Psych.safe_l...

...oad yaml # => 例外発生
Psych.safe_load yaml, [], [], true # => エイリアスが読み込まれる
//}

yaml にホワイトリストにないクラスが含まれていた場合は、
Psych::DisallowedClass 例外が発生します。

yaml がエイリアスを含んでいて al...

...iases パラメーターが false の時、
Psych::BadAlias 例外が発生します。

filename はパース中に発生した例外のメッセージに用います。

キーワード引数 symbolize_names に true を指定した場合はハッシュのキー
を Symbol に変換して返しま...

Psych.load(yaml, filename = nil, fallback = false) -> object (25.0)

2.3.0

特異メソッド

YAML ドキュメントを Ruby のデータ構造(オブジェクト)に変換します。

...IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@param fallback 引数 yaml に空のYAMLを指定した場合の戻り値を指定します。デフォルトは false です。
@raise Psych::SyntaxError YAMLドキュメント...

...文法エラーが発見されたときに発生します
@see Psych.parse

//emlist[例][ruby]{
Psych.load("--- a") # => 'a'
Psych.load("---\n - a\n - b") # => ['a', 'b']

begin
Psych.load("--- `", "file.txt")
rescue Psych::SyntaxError => ex
p ex.file # => 'file.txt'
p ex.message...

Psych.load_documents(yaml) -> [object] (25.0)

2.3.0

特異メソッド

複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。このメソッドは deprecated です。Psych.load_stream を代わりに使ってください。

...ジェクトに変換します。
このメソッドは deprecated です。Psych.load_stream を代わりに
使ってください。

@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたとき...

Psych.load_documents(yaml) {|obj| ... } -> () (25.0)

2.3.0

特異メソッド

絞り込み条件を変える

Psych.load_stream(yaml, filename=nil) -> [object] (25.0)

2.3.0

特異メソッド

複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。

...を返します。

//emlist[例][ruby]{
Psych.load_stream("--- foo\n...\n--- bar\n...") # => ['foo', 'bar']
//}

ブロックありの場合は各オブジェクト引数としてそのブロックを呼び出します。

//emlist[例][ruby]{
list = []
Psych.load_stream("--- foo\n...\n--- bar\n......

...に用います。

@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します...

Psych.load_stream(yaml, filename=nil) {|obj| ... } -> () (25.0)

2.3.0

特異メソッド

複数の YAML ドキュメントを含むデータを Ruby のオブジェクトに変換します。

Psych.parse(yaml, filename = nil) -> Psych::Nodes::Document (25.0)

2.3.0

特異メソッド

YAML ドキュメントをパースし、YAML の AST を返します。

...用います。

AST については Psych::Nodes を参照してください。

@param yaml YAML ドキュメント(文字列 or IO オブジェクト)
@param filename Psych::SyntaxError 発生時にファイル名として表示する文字列。
@raise Psych::SyntaxError YAMLドキュメント...

...に文法エラーが発見されたときに発生します
@see Psych.load

//emlist[例][ruby]{
Psych.parse("---\n - a\n - b") # => #<Psych::Nodes::Document:...>

begin
Psych.parse("--- `", "file.txt")
rescue Psych::SyntaxError => ex
p ex.file # => 'file.txt'
p ex.message # => "(file.txt...

別のキーワード

種類

クラス

モジュール

キーワード

検索結果

先頭5件

Psych.libyaml_version -> [Integer, Integer, Integer] (18307.0)

Psych::Emitter#indentation -> Integer (18307.0)

Psych::Emitter#indentation=(level) (18307.0)

Psych::LIBYAML_VERSION -> String (18307.0)

Psych::Nodes::Document#version -> [Integer] (18307.0)

Psych::Nodes::Document#version=(ver) (18307.0)

Psych::VERSION -> String (18307.0)

Psych::Exception (18007.0)

Psych::Nodes::Node#to_yaml(io=nil, options={}) -> String | IO (1027.0)

Psych::Nodes::Node#yaml(io=nil, options={}) -> String | IO (1027.0)

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

Psych.dump(o, options = {}) -> String (418.0)

Psych::Stream.new(io) -> Psych::Stream (364.0)

Psych::Emitter.new(io) -> Psych::Emitter (346.0)

Object#psych_to_yaml(options = {}) -> String (307.0)

Object#to_yaml(options = {}) -> String (307.0)

Psych::Handler#start_document(version, tag_directives, implicit) -> () (307.0)

Psych::Nodes::Document.new(version=[], tag_directives=[], implicit=false) -> Psych::Nodes::Document (307.0)

Psych::Visitors::YAMLTree.new(options = {}, emitter = Psych::TreeBuilder.new, ss = Psych::ScalarScanner.new) -> Psych::Visitors::YAMLTree (307.0)

Psych::Stream (55.0)

Psych::Stream#finish -> () (55.0)

Psych.safe_load(yaml, whitelist_classes = [], whitelist_symbols = [], aliases = false, filename = nil) -> object (43.0)

Psych.load(yaml, filename = nil, fallback = false) -> object (25.0)

Psych.load_documents(yaml) -> [object] (25.0)

Psych.load_documents(yaml) {|obj| ... } -> () (25.0)

Psych.load_stream(yaml, filename=nil) -> [object] (25.0)

Psych.load_stream(yaml, filename=nil) {|obj| ... } -> () (25.0)

Psych.parse(yaml, filename = nil) -> Psych::Nodes::Document (25.0)