検索結果

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

• 2.4.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#yaml_initialize (54907.0)

• 2.4.0

• インスタンスメソッド

@todo

@todo

• Gem::Specification

Gem::ConfigFile#load_file(file_name) -> object (45970.0)

• 2.4.0

• インスタンスメソッド

与えられたファイル名のファイルが存在すれば YAML ファイルとしてロードします。

与えられたファイル名のファイルが存在すれば YAML ファイルとしてロードします。

@param file_name YAML 形式で記述された設定ファイル名を指定します。

• Gem::ConfigFile

Gem::Commands::BuildCommand#yaml?(filename) -> bool (45955.0)

• 2.4.0

• インスタンスメソッド

与えられたファイル名を持つファイルが yaml ファイルである場合に真を返します。

与えられたファイル名を持つファイルが yaml ファイルである場合に真を返します。

@param filename ファイル名を指定します。

• Gem::Commands::BuildCommand

YAML::DBM#delete_if {|key, val| ... } -> YAML::DBM (45907.0)

• 2.4.0

• インスタンスメソッド

ブロックを評価した値が真であれば該当する要素を削除します。

ブロックを評価した値が真であれば該当する要素を削除します。

自身を返します。このメソッドは self を破壊的に変更します。

@raise DBMError 要素の削除に失敗した場合に発生します。

• YAML::DBM

絞り込み条件を変える

Psych::Visitors::YAMLTree#finish -> Psych::Nodes::Stream|nil (45604.0)

• 2.4.0

• インスタンスメソッド

変換を終了し、構築した AST を返します。

変換を終了し、構築した AST を返します。

このメソッドは2回呼び出さないでください。

@see Psych::Visitors::YAMLTree#tree

• Psych::Visitors::YAMLTree

Psych::Visitors::YAMLTree#finished -> bool (45604.0)

• 2.4.0

• インスタンスメソッド

Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば 真を返します。

Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば
真を返します。

まだならば偽を返します。

• Psych::Visitors::YAMLTree

Psych::Visitors::YAMLTree#finished? -> bool (45604.0)

• 2.4.0

• インスタンスメソッド

Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば 真を返します。

Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば
真を返します。

まだならば偽を返します。

• Psych::Visitors::YAMLTree

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

• 2.4.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 (37030.0)

• 2.4.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 (37030.0)

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

YAML::DBM#index(value) -> String | nil (36940.0)

• 2.4.0

• インスタンスメソッド

value を持つ要素のキーを返します。

value を持つ要素のキーを返します。

対応するキーが見つからなかった場合は nil を返します。

@param value 検索したい値を指定します。YAML 形式に変換できるオブジェク
トが指定できます。

[注意] 非推奨のメソッドです。代わりに #key を使用してください。

@see YAML::DBM#key

• YAML::DBM

Psych::Handler#alias(anchor) -> () (36622.0)

• 2.4.0

• インスタンスメソッド

anchor という名前の alias を見付けたときに呼び出されます。

anchor という名前の alias を見付けたときに呼び出されます。

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

@param anchor aliasのアンカー文字列

=== 例

以下の YAMLドキュメントは自分自身への参照を持つ配列を表しています。

--- &ponies
- first element
- *ponies

この &ponies が anchor で *ponies が alias です。この場合、
alias メソッドは "poines" という引数で呼び出されます。

• Psych::Handler

YAML::DBM#invert -> {object => String} (36604.0)

• 2.4.0

• インスタンスメソッド

値からキーへのハッシュを返します。

値からキーへのハッシュを返します。

異なるキーに対して等しい値が登録されている場合の結果は不定であることに
注意してください、そのような場合にこのメソッドを利用することは意図され
ていません。

• YAML::DBM

YAML::DBM#shift -> [String, object] (36304.0)

• 2.4.0

• インスタンスメソッド

データベース中のキー、値を一つ取り出し、データベースから削除します。

データベース中のキー、値を一つ取り出し、データベースから削除します。

[キー, 値]を返します。取得される要素の順番は保証されません。

• YAML::DBM

絞り込み条件を変える

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

• 2.4.0

• インスタンスメソッド

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

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

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

@see Gem::Specification.from_yaml

• Gem::Package::TarInput
• IO

YAML::DBM#each_pair {|key, val| ... } -> YAML::DBM (27910.0)

• 2.4.0

• インスタンスメソッド

自身のキーと値を引数としてブロックを評価します。

自身のキーと値を引数としてブロックを評価します。

自身を返します。

• YAML::DBM

Psych::Handler#start_mapping(anchor, tag, implicit, style) -> () (27658.0)

• 2.4.0

• インスタンスメソッド

mapping の開始を見付けたときに呼び出されます。

mapping の開始を見付けたときに呼び出されます。

anchor には map に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。

tag には map に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。

implicit には map が implicit に開始されたかどうかが
真偽値で渡されます。

style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes::Mapping::BLOCK
...

• Psych::Handler

YAML::DBM#select { ... } -> [[String, object]] (27622.0)

• 2.4.0

• インスタンスメソッド

ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に 格納して返します。ブロックが与えられなかった場合は、keys に対応する値を 配列に格納して返します。

ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に
格納して返します。ブロックが与えられなかった場合は、keys に対応する値を
配列に格納して返します。

@param keys キーを文字列で指定します。複数指定することができます。

ブロックを与えるかどうかで戻り値が異なる事に注意してください。

@see YAML::DBM#values_at

• YAML::DBM

Psych::Visitors::YAMLTree#tree -> Psych::Nodes::Stream|nil (27604.0)

• 2.4.0

• インスタンスメソッド

変換を終了し、構築した AST を返します。

変換を終了し、構築した AST を返します。

内部で finish を呼び出し、変換処理を終了します。

このメソッドを2回以上呼ぶと、2回目以降は nil を返します。

@see Psych::Visitors::YAMLTree#finish

• Psych::Visitors::YAMLTree

絞り込み条件を変える

YAML::DBM#delete(key) -> object | nil (27604.0)

• 2.4.0

• インスタンスメソッド

key をキーとする要素を削除します。

key をキーとする要素を削除します。

削除した要素を返します。key に対応する値が見つからなかった場合は nil を
返します。

@param key キーを文字列で指定します。

@raise DBMError 要素の削除に失敗した場合に発生します。

• YAML::DBM

Psych::Visitors::YAMLTree#start(encoding = Nodes::Stream::UTF8) -> Psych::Nodes::Stream (27370.0)

• 2.4.0

• インスタンスメソッド

Ruby オブジェクトから YAML AST への変換のための準備をします。

Ruby オブジェクトから YAML AST への変換のための準備をします。


Psych::Visitors::YAMLTree#push が呼び出されたとき、
まだこのメソッドが呼び出されていなければ push メソッドがこの
メソッドを呼び出し、変換の準備をします。

encoding には以下のいずれかを指定できます。
* Psych::Nodes::Node::UTF8
* Psych::Nodes::Node::UTF16BE
* Psych::Nodes::Node::UTF16LE

@param encoding YAML AST に設定するエンコーディング

• Psych::Visitors::YAMLTree

Psych::ScalarScanner#tokenize(string) -> object (27352.0)

• 2.4.0

• インスタンスメソッド

YAML の scalar である文字列を Ruby のオブジェクトに変換した ものを返します。

YAML の scalar である文字列を Ruby のオブジェクトに変換した
ものを返します。

scanner = Psych::ScalarScanner.new
p scanner.tokenize("yes") # => true
p scanner.tokenize("year") # => "year"
p scanner.tokenize("12") # => 12

@param string 変換文字列

• Psych::ScalarScanner

Psych::Visitors::YAMLTree#started -> bool (27304.0)

• 2.4.0

• インスタンスメソッド

Psych::Visitors::YAMLTree#start をすでに呼び出しているならば 真を返します。

Psych::Visitors::YAMLTree#start をすでに呼び出しているならば
真を返します。

まだならば偽を返します。

• Psych::Visitors::YAMLTree

Psych::Visitors::YAMLTree#started? -> bool (27304.0)

• 2.4.0

• インスタンスメソッド

Psych::Visitors::YAMLTree#start をすでに呼び出しているならば 真を返します。

Psych::Visitors::YAMLTree#start をすでに呼び出しているならば
真を返します。

まだならば偽を返します。

• Psych::Visitors::YAMLTree

絞り込み条件を変える

Psych::Visitors::YAMLTree#<<(object) (27022.0)

• 2.4.0

• インスタンスメソッド

変換対象の Ruby オブジェクトを追加します。

変換対象の Ruby オブジェクトを追加します。

@param object YAML AST へ変換する Ruby オブジェクト

• Psych::Visitors::YAMLTree

Psych::Visitors::YAMLTree#push(object) (27022.0)

• 2.4.0

• インスタンスメソッド

変換対象の Ruby オブジェクトを追加します。

変換対象の Ruby オブジェクトを追加します。

@param object YAML AST へ変換する Ruby オブジェクト

• Psych::Visitors::YAMLTree

Psych::Handler#scalar(value, anchor, tag, plain, quoted, style) -> () (18940.0)

• 2.4.0

• インスタンスメソッド

スカラー値を見付けたときに呼び出されます。

スカラー値を見付けたときに呼び出されます。

value にはスカラー値の文字列が渡されます。

anchor にはスカラー値に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。

tag にはスカラー値に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。

plain は plain style であるかどうか、quoted は quoted style であるかどうか
が渡されます。style には node の style が整数値で渡されます。
style は次の値のいずれか...

• Psych::Handler

YAML::DBM#[](key) -> object | nil (18622.0)

• 2.4.0

• インスタンスメソッド

データベースからキーを探して対応する要素の値を返します。

データベースからキーを探して対応する要素の値を返します。

対応する値が見つからなかった場合は nil を返します。DBM#[] とは異
なり、IndexError は発生しません。

@param key キーを文字列で指定します。

@see YAML::DBM#fetch

• IndexError
• YAML::DBM

YAML::DBM#fetch(key, ifnone = nil) -> object (18622.0)

• 2.4.0

• インスタンスメソッド

データベースからキーを探して対応する要素の値を返します。

データベースからキーを探して対応する要素の値を返します。

対応する値が見つからなかった場合は ifnone で指定した値を返します。

@param key キーを文字列で指定します。

@see YAML::DBM#[]

• YAML::DBM

絞り込み条件を変える

YAML::DBM#key(value) -> String | nil (18622.0)

• 2.4.0

• インスタンスメソッド

value を持つ要素のキーを返します。

value を持つ要素のキーを返します。

対応するキーが見つからなかった場合は nil を返します。

@param value 検索したい値を指定します。YAML 形式に変換できるオブジェク
トが指定できます。

• YAML::DBM

YAML::DBM#reject {|key, val| ... } -> {String => object} (18604.0)

• 2.4.0

• インスタンスメソッド

ブロックを評価した値が真であれば該当する要素を削除します。

ブロックを評価した値が真であれば該当する要素を削除します。

新しく Hash オブジェクトを作成して返します。

• Hash
• YAML::DBM

YAML::DBM#to_a -> [[String, object]] (18304.0)

• 2.4.0

• インスタンスメソッド

キーと値のペアを配列に変換して返します。

キーと値のペアを配列に変換して返します。

• YAML::DBM

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

• 2.4.0

• インスタンスメソッド

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

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

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

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

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

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


@param version ...

• Psych::Handler

Psych::Handler#start_sequence(anchor, tag, implicit, style) -> () (9658.0)

• 2.4.0

• インスタンスメソッド

sequence の開始を見付けたときに呼び出されます。

sequence の開始を見付けたときに呼び出されます。

anchor には sequence に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。

tag には sequence に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。

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

style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes:...

• Psych::Handler

絞り込み条件を変える

Psych::Handler#end_document(implicit) -> () (9640.0)

• 2.4.0

• インスタンスメソッド

ドキュメントが終了したときに呼び出されます。

ドキュメントが終了したときに呼び出されます。

ドキュメントが implicit に終わったならば implicit には真が渡されます。

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

@param implicit ドキュメントが implicit に終わったかどうか

=== 例

以下の YAML ドキュメントでは implicit は true です。
---
hello world

また、以下の YAML ドキュメントでは implicit は false です。
---
hello world
...

• Psych::Handler

Kernel#psych_y(*objects) -> String (9370.0)

• 2.4.0

• インスタンスメソッド

objects を YAML document に変換します。

objects を YAML document に変換します。

このメソッドは irb 上でのみ定義されます。

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

@param objects YAML document に変換する Ruby のオブジェクト

• Kernel
• syck

Kernel#y(*objects) -> String (9370.0)

• 2.4.0

• インスタンスメソッド

objects を YAML document に変換します。

objects を YAML document に変換します。

このメソッドは irb 上でのみ定義されます。

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

@param objects YAML document に変換する Ruby のオブジェクト

• Kernel
• syck

Psych::Handler#start_stream(encoding) -> () (9370.0)

• 2.4.0

• インスタンスメソッド

YAML ストリームの始まりで呼び出されます。

YAML ストリームの始まりで呼び出されます。

encoding にはストリームのエンコーディング(以下のいずれか)が渡されます。
* Psych::Parser::UTF8
* Psych::Parser::UTF16BE
* Psych::Parser::UTF16LE

このメソッドは YAML のストリームごとに呼び出されます。一つのストリームには
複数のドキュメントが含まれている可能性があります。

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

@param encoding ストリームのエンコーディング(整数値)

• Psych::Handler

Psych::Nodes::Node#tag -> String | nil (622.0)

• 2.4.0

• インスタンスメソッド

ノードに付加されたタグを返します。

ノードに付加されたタグを返します。

タグが付加されていない場合は nil を返します。

ast = Psych.parse(<<EOS)
---
- !!str a
- b
EOS

p ast.root.children[0].value # => "a"
p ast.root.children[0].tag # => "tag:yaml.org,2002:str"

p ast.root.children[1].value # => "b"
p ast.root.children[1].tag # => nil

• Psych::Nodes::Node

絞り込み条件を変える