検索結果

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

• 2.4.0

• 特異メソッド

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

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

入力に複数のドキュメントが含まれている場合は、先頭のものを AST に変換して
返します。

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

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

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

• Psych
• Psych::Nodes
• Psych::SyntaxError

Psych.parse_stream(yaml) -> Psych::Nodes::Stream (51397.0)

• 2.4.0

• 特異メソッド

YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。

YAML ドキュメントをパースします。
yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。

ブロックなしの場合は YAML の AST (すべての YAML ドキュメントを
保持した Psych::Nodes::Stream オブジェクト)を返します。

ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。


@see Psych::Nodes

//emlist[例][ruby]{
Psych.parse_stream("--...

• Psych
• Psych::Nodes
• Psych::Nodes::Stream

Psych.parse_file(filename) -> Psych::Nodes::Document (51325.0)

• 2.4.0

• 特異メソッド

filename で指定したファイルをパースして YAML の AST を返します。

filename で指定したファイルをパースして YAML の AST を返します。

@param filename パースするファイルの名前
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します

• Psych

Psych.parser -> Psych::Parser (51307.0)

• 2.4.0

• 特異メソッド

デフォルトで使われるのパーサを返します。

デフォルトで使われるのパーサを返します。

• Psych

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

• 2.4.0

• 特異メソッド

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

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

入力に複数のドキュメントが含まれている場合は、先頭のものを変換して
返します。

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


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

• Psych
• Psych::SyntaxError
• Symbol

絞り込み条件を変える

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

• 2.4.0

• 特異メソッド

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

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

デフォルトでは以下のクラスのオブジェクトしか変換しません。

* TrueClass
* FalseClass
* NilClass
* Numeric
* String
* Array
* Hash

再帰的なデータ構造はデフォルトでは許可されていません。
任意のクラスを許可するには whitelist_classes を指定すると、
そのクラスが追加されます。例えば Date クラスを許可するには
以下のように書いてください:

//emlist[][ruby]{
Psych.s...

• Psych
• Psych::SyntaxError
• Symbol

Psych.parse_stream(yaml) {|node| ... } -> () (51097.0)

• 2.4.0

• 特異メソッド

YAML ドキュメントをパースします。 yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。

YAML ドキュメントをパースします。
yaml が 複数の YAML ドキュメントを含む場合を取り扱うことができます。

ブロックなしの場合は YAML の AST (すべての YAML ドキュメントを
保持した Psych::Nodes::Stream オブジェクト)を返します。

ブロック付きの場合は、そのブロックに最初の YAML ドキュメント
の Psych::Nodes::Document オブジェクトが渡されます。
この場合の返り値には意味がありません。


@see Psych::Nodes

//emlist[例][ruby]{
Psych.parse_stream("--...

• Psych
• Psych::Nodes
• Psych::Nodes::Stream

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

• 2.4.0

• 特異メソッド

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

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

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

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

: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文字列で指定します
: :header
出力にヘッダを付けるかどうかを真偽値で指定します
: :indentation
イン...

• Psych

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

• 2.4.0

• 特異メソッド

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

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

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

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

: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文字列で指定します
: :header
出力にヘッダを付けるかどうかを真偽値で指定します
: :indentation
イン...

• Psych

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

• 2.4.0

• 特異メソッド

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

複数の 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...") do |ruby|
list << ru...

• Psych
• Psych::SyntaxError

絞り込み条件を変える

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

• 2.4.0

• 特異メソッド

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

複数の 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...") do |ruby|
list << ru...

• Psych
• Psych::SyntaxError

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

• 2.4.0

• 特異メソッド

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

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

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

• Psych

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

• 2.4.0

• 特異メソッド

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

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

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

• Psych

Psych.dump_stream(*objects) -> String (51022.0)

• 2.4.0

• 特異メソッド

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

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

@param objects 変換対象のオブジェクト列

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

• Psych

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

• 2.4.0

• 特異メソッド

libyaml のバージョンを返します。

libyaml のバージョンを返します。

[major, minor patch-level] という 3 つの整数からなる配列を返します。

@see Psych::LIBYAML_VERSION

• Psych

絞り込み条件を変える

Psych.load_file(filename) -> object (51022.0)

• 2.4.0

• 特異メソッド

filename で指定したファイルを YAML ドキュメントとして Ruby のオブジェクトに変換します。

filename で指定したファイルを YAML ドキュメントとして
Ruby のオブジェクトに変換します。

@param filename ファイル名
@raise Psych::SyntaxError YAMLドキュメントに文法エラーが発見されたときに発生します

• Psych

Psych.to_json(o) -> String (51004.0)

• 2.4.0

• 特異メソッド

Ruby のオブジェクト o を JSON の文字列に変換します。

Ruby のオブジェクト o を JSON の文字列に変換します。

@param o 変換対象となるオブジェクト

• Psych

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

• 2.4.0

• 特異メソッド

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

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

options には構築される YAML AST に設定されるオプション設定を指定します。
Psych.dump と同じオプションが指定できます。

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

ss は Ruby の String が YAML document 上で quote が必要かどうか
を判定するための Psych::ScalarScanner オブジェクトを渡します。

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

@param...

• Psych::ScalarScanner
• Psych::TreeBuilder
• Psych::Visitors::YAMLTree
• String

Psych::Nodes::Stream.new(encoding = Psych::Nodes::Stream::UTF8) -> Psych::Nodes::Stream (33712.0)

• 2.4.0

• 特異メソッド

Psych::Nodes::Stream オブジェクトを生成して返します。

Psych::Nodes::Stream オブジェクトを生成して返します。

encoding には stream に使われるエンコーディングを指定します。
以下のいずれかを指定します。
* Psych::Nodes::Node::UTF8
* Psych::Nodes::Node::UTF16BE
* Psych::Nodes::Node::UTF16LE

@param encoding エンコーディング

• Psych::Nodes::Stream

Psych::Nodes::Scalar.new(value, anchor=nil, tag=nil, plain=true, quoted=false, style=ANY) -> Psych::Nodes:Scalar (33415.0)

• 2.4.0

• 特異メソッド

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

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

value は scalar の値を文字列で指定します。

anchor には scalar に付加されている anchor を文字列で指定します。
anchor を付けない場合には nil を指定します。

tag には scalar に付加されている tag を文字列で指定します。
tag を付けない場合には nil を指定します。

plain は plain style であるかどうか、quoted は quoted style であるかどうか
を指定します。style には node の style を整数値で渡します。
style は次...

• Psych::Nodes::Scalar

絞り込み条件を変える

Psych::Nodes::Mapping.new(anchor=nil, tag=nil, implicit=true, style=BLOCK) -> Psych::Nodes::Mapping (33361.0)

• 2.4.0

• 特異メソッド

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

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

anchor には mapping に付加されている anchor を文字列で指定します。
anchor を付けない場合には nil を指定します。

tag には mapping に付加されている tag を文字列で指定します。
tag を付けない場合には nil を指定します。

implicit には mapping が implicit に開始されたかどうかを
真偽値で指定します。

style には YAML ドキュメント上の style を整数で指定します。以下のいずれ
かを指定できます。
* Psych::Nodes::...

• Psych::Nodes::Mapping

Psych::Nodes::Sequence.new(anchor=nil, tag=nil, implicit=true, style=BLOCK) -> Psych::Nodes::Sequence (33361.0)

• 2.4.0

• 特異メソッド

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

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

anchor には sequence に付加されている anchor を文字列で指定します。
anchor を付けない場合には nil を指定します。

tag には sequence に付加されている tag を文字列で指定します。
tag を付けない場合には nil を指定します。

implicit には sequence が implicit に開始されたかどうかを
真偽値で指定します。

style には YAML ドキュメント上の style を整数で指定します。以下のいずれ
かを指定できます。
* Psych::Nod...

• Psych::Nodes::Sequence

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

• 2.4.0

• 特異メソッド

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

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

version にはドキュメントのバージョンを指定します。
[major, minor] という配列で指定します。

tag_directives には tag directive の配列を指定します。
それぞれの tag は [prefix, suffix] という文字列の配列で
表現します。

implicit にはドキュメントが implicit に始まっているかどうかを
真偽値で指定します。

@param version YAML ドキュメントのバージョン
@param tag_directives tag directive の配列...

• Psych::Nodes::Document

Psych::Parser.new(handler = Handler.new) -> Psych::Parser (33325.0)

• 2.4.0

• 特異メソッド

新たなパーサオブジェクトを生成して返します。

新たなパーサオブジェクトを生成して返します。

handler で YAML のイベントを処理するハンドラを指定します。
詳しくは Psych::Parser を参照してください。

@param handler YAML のイベントを処理するハンドラ

• Psych::Parser

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

• 2.4.0

• 特異メソッド

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

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

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

• Psych::Emitter

絞り込み条件を変える

Psych::Nodes::Alias.new(anchor) -> Psych::Nodes::Alias (33307.0)

• 2.4.0

• 特異メソッド

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

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

anchor で指す先の anchor を指定します。

@param anchor 指す先の anchor

• Psych::Nodes::Alias

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

• 2.4.0

• 特異メソッド

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

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

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

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

• Psych::Stream

Psych::TreeBuilder.new -> Psych::TreeBuilder (33307.0)

• 2.4.0

• 特異メソッド

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

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

• Psych::TreeBuilder

Psych::ScalarScanner.new (33004.0)

• 2.4.0

• 特異メソッド

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

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

• Psych::ScalarScanner

Object.yaml_tag(tag) -> () (24076.0)

• 2.4.0

• 特異メソッド

クラスと tag の間を関連付けます。

クラスと tag の間を関連付けます。

これによって tag 付けされた YAML ドキュメントを Ruby のオブジェクトに
変換したりその逆をしたりすることができます。

@param tag 対象のクラスに関連付けるタグの文字列

=== Example
require 'psych'

class Foo
def initialize(x)
@x = x
end

attr_reader :x
end

# Dumps Ruby object normally
p Psych.dump(Foo.new(3))
...

• Object

絞り込み条件を変える

YAML::Store.new(file_name, thread_safe = false, yaml_opts = {}) -> YAML::Store (22.0)

• 2.4.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param file_name 格納先のファイル名。ファイルがない場合は作成します。既
にファイルが存在する場合はその内容を読み込みます。

@param thread_safe 自身をスレッドセーフにして初期化するかどうか。

@param yaml_opts YAML 出力時のオプションを Hash で指定します。
詳しくは Psych.dump を参照してください。

• Hash
• YAML::Store

YAML::Store.new(file_name, yaml_opts = {}) -> YAML::Store (22.0)

• 2.4.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param file_name 格納先のファイル名。ファイルがない場合は作成します。既
にファイルが存在する場合はその内容を読み込みます。

@param thread_safe 自身をスレッドセーフにして初期化するかどうか。

@param yaml_opts YAML 出力時のオプションを Hash で指定します。
詳しくは Psych.dump を参照してください。

• Hash
• YAML::Store