検索結果

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

• 2.6.0

• インスタンスメソッド

AST を YAML ドキュメントに変換します。

AST を YAML ドキュメントに変換します。

io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。

io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。

Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。

options には以下が指定できます。

: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文...

• IO
• Psych::Nodes::Node
• Psych::Nodes::Stream

Gem::Specification.from_yaml(input) -> Gem::Specification (27706.0)

• 2.6.0

• 特異メソッド

YAML ファイルから gemspec をロードします。

YAML ファイルから gemspec をロードします。

YAML ファイルから Gem::Specification をロードすると、通常の Ruby オブジェクトの
初期化ルーチン (#initialize) を通りません。このメソッドは初期化ルーチンの一部を実行し、
gemspec のバージョンチェックも行います。

@param input 文字列か IO オブジェクトを指定します。

• Gem::Specification
• IO

Gem::Specification.normalize_yaml_input(input) -> String (27388.0)

• 2.6.0

• 特異メソッド

YAML 形式の gemspec を正しくフォーマットします。

YAML 形式の gemspec を正しくフォーマットします。

@param input 文字列か IO オブジェクトを指定します。

• Gem::Specification
• IO

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

• 2.6.0

• インスタンスメソッド

AST を YAML ドキュメントに変換します。

AST を YAML ドキュメントに変換します。

io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。

io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。

Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。

options には以下が指定できます。

: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文...

• IO
• Psych::Nodes::Node
• Psych::Nodes::Stream

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

• 2.6.0

• インスタンスメソッド

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

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

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

syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予定であるため、特別の事情がない限り to_yaml を用いてください。

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

• Object
• syck

絞り込み条件を変える

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

• 2.6.0

• インスタンスメソッド

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

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

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

syck に to_yaml メソッドがあるため、
psych_to_yaml が別名として定義されています。将来的に
syck が廃止された場合 psych_to_yaml は廃止
される予定であるため、特別の事情がない限り to_yaml を用いてください。

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

• Object
• syck

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

• 2.6.0

• インスタンスメソッド

YAML ドキュメントのバージョンを設定します。

YAML ドキュメントのバージョンを設定します。

@param ver 設定するバージョン
@see Psych::Nodes::Document#version,
Psych::Nodes::Document.new

• Psych::Nodes::Document

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

• 2.6.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.dump(o, io, options = {}) -> () (850.0)

• 2.6.0

• 特異メソッド

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

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

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

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

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

• Psych

Gem::Package::TarInput#load_gemspec(io) -> Gem::Specification | nil (772.0)

• 2.6.0

• インスタンスメソッド

YAML 形式の gemspec を io から読み込みます。

YAML 形式の gemspec を io から読み込みます。

@param io 文字列か IO オブジェクトを指定します。

@see Gem::Specification.from_yaml

• Gem::Package::TarInput
• IO

絞り込み条件を変える

Psych.safe_load(yaml, legacy_permitted_classes=[], legacy_permitted_symbols=[], legacy_aliases=false, legacy_filename=nil) -> object (715.0)

• 2.6.0

• 特異メソッド

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

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

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

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

再帰的なデータ構造はデフォルトでは許可されていません。

任意のクラスを許可するにはキーワード引数 permitted_classes を指定すると、
そのクラスが追加されます。例えば Date クラスを許可するには
以下のように書いてください:

//emlist[permitte...

• Psych
• Psych::SyntaxError
• Symbol

Psych.safe_load(yaml, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false) -> object (715.0)

• 2.6.0

• 特異メソッド

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

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

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

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

再帰的なデータ構造はデフォルトでは許可されていません。

任意のクラスを許可するにはキーワード引数 permitted_classes を指定すると、
そのクラスが追加されます。例えば Date クラスを許可するには
以下のように書いてください:

//emlist[permitte...

• Psych
• Psych::SyntaxError
• Symbol

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

• 2.6.0

• 特異メソッド

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

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

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

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

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

• Psych

Psych.load(yaml, filename = nil, fallback: false, symbolize_names: false) -> object (550.0)

• 2.6.0

• 特異メソッド

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

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

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

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


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

• Psych
• Psych::SyntaxError
• Symbol

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

• 2.6.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::Handler#start_document(version, tag_directives, implicit) -> () (475.0)

• 2.6.0

• インスタンスメソッド

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

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

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

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

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

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


@param version ...

• Psych::Handler

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

• 2.6.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| ... } -> () (463.0)

• 2.6.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::Stream.new(io) -> Psych::Stream (394.0)

• 2.6.0

• 特異メソッド

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

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

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

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

• Psych::Stream

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

• 2.6.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

絞り込み条件を変える