ライブラリ
- psych (23)
-
rubygems
/ commands / build _ command (1) -
rubygems
/ config _ file (1) -
rubygems
/ package / tar _ input (1) -
yaml
/ dbm (23)
クラス
-
Gem
:: Commands :: BuildCommand (1) -
Gem
:: ConfigFile (1) -
Gem
:: Package :: TarInput (1) - Module (2)
-
Psych
:: Handler (8) -
Psych
:: Nodes :: Document (1) -
Psych
:: Nodes :: Node (3) -
Psych
:: Stream (2) -
Psych
:: Visitors :: YAMLTree (7) -
RDoc
:: Options (1) -
YAML
:: DBM (23)
キーワード
- [] (1)
- []= (1)
- alias (1)
- delete (1)
-
delete
_ if (1) - each (1)
-
each
_ pair (1) -
each
_ value (1) -
end
_ document (1) -
end
_ stream (1) - fetch (1)
- finish (1)
- finished (1)
- finished? (1)
-
has
_ value? (1) - index (1)
- invert (1)
- key (1)
-
load
_ file (1) -
load
_ gemspec (1) -
psych
_ yaml _ as (1) - reject (1)
- replace (1)
- scalar (1)
- select (2)
- shift (1)
- start (3)
-
start
_ document (1) -
start
_ mapping (1) -
start
_ sequence (1) -
start
_ stream (1) - started (1)
- started? (1)
- store (1)
- tag (1)
-
to
_ a (1) -
to
_ hash (1) -
to
_ yaml (1) - tree (1)
- update (1)
- values (1)
-
values
_ at (1) - version (1)
- yaml? (1)
-
yaml
_ as (1)
検索結果
先頭5件
-
Psych
:: Nodes :: Node # yaml(io=nil , options={}) -> String | IO (72676.0) -
AST を YAML ドキュメントに変換します。
AST を YAML ドキュメントに変換します。
io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が指定できます。
: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文... -
Psych
:: Nodes :: Node # to _ yaml(io=nil , options={}) -> String | IO (36676.0) -
AST を YAML ドキュメントに変換します。
AST を YAML ドキュメントに変換します。
io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が指定できます。
: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文... -
YAML
:: DBM # delete _ if {|key , val| . . . } -> YAML :: DBM (27907.0) -
ブロックを評価した値が真であれば該当する要素を削除します。
ブロックを評価した値が真であれば該当する要素を削除します。
自身を返します。このメソッドは self を破壊的に変更します。
@raise DBMError 要素の削除に失敗した場合に発生します。 -
Gem
:: Commands :: BuildCommand # yaml?(filename) -> bool (27655.0) -
与えられたファイル名を持つファイルが yaml ファイルである場合に真を返します。
与えられたファイル名を持つファイルが yaml ファイルである場合に真を返します。
@param filename ファイル名を指定します。 -
Module
# psych _ yaml _ as(tag) -> () (27646.0) -
クラスと tag の間を関連付けます。
クラスと tag の間を関連付けます。
これによって tag 付けされた YAML ドキュメントを Ruby のオブジェクトに
変換したりその逆をしたりすることができます。
この method は deprecated です。 Object.yaml_tag を
かわりに使ってください。
@param tag 対象のクラスに関連付けるタグの文字列 -
Module
# yaml _ as(tag) -> () (27646.0) -
クラスと tag の間を関連付けます。
クラスと tag の間を関連付けます。
これによって tag 付けされた YAML ドキュメントを Ruby のオブジェクトに
変換したりその逆をしたりすることができます。
この method は deprecated です。 Object.yaml_tag を
かわりに使ってください。
@param tag 対象のクラスに関連付けるタグの文字列 -
YAML
:: DBM # index(value) -> String | nil (27640.0) -
value を持つ要素のキーを返します。
value を持つ要素のキーを返します。
対応するキーが見つからなかった場合は nil を返します。
@param value 検索したい値を指定します。YAML 形式に変換できるオブジェク
トが指定できます。
[注意] 非推奨のメソッドです。代わりに #key を使用してください。
@see YAML::DBM#key -
Psych
:: Visitors :: YAMLTree # finished -> bool (27604.0) -
Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば 真を返します。
Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば
真を返します。
まだならば偽を返します。 -
Psych
:: Visitors :: YAMLTree # finished? -> bool (27604.0) -
Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば 真を返します。
Psych::Visitors::YAMLTree#finish をすでに呼び出しているならば
真を返します。
まだならば偽を返します。 -
Psych
:: Visitors :: YAMLTree # started -> bool (27604.0) -
Psych::Visitors::YAMLTree#start をすでに呼び出しているならば 真を返します。
Psych::Visitors::YAMLTree#start をすでに呼び出しているならば
真を返します。
まだならば偽を返します。 -
Psych
:: Visitors :: YAMLTree # started? -> bool (27604.0) -
Psych::Visitors::YAMLTree#start をすでに呼び出しているならば 真を返します。
Psych::Visitors::YAMLTree#start をすでに呼び出しているならば
真を返します。
まだならば偽を返します。 -
YAML
:: DBM # delete(key) -> object | nil (27604.0) -
key をキーとする要素を削除します。
key をキーとする要素を削除します。
削除した要素を返します。key に対応する値が見つからなかった場合は nil を
返します。
@param key キーを文字列で指定します。
@raise DBMError 要素の削除に失敗した場合に発生します。 -
YAML
:: DBM # update(other) -> self (27604.0) -
自身と other の内容をマージ(統合)します。
自身と other の内容をマージ(統合)します。
重複するキーに対応する値は other の内容で上書きされます。
@param other Hash、DBM オブジェクトを指定します。
@raise DBMError 更新に失敗した場合に発生します。 -
YAML
:: DBM # each -> YAML :: DBM (18910.0) -
自身のキーと値を引数としてブロックを評価します。
自身のキーと値を引数としてブロックを評価します。
自身を返します。 -
YAML
:: DBM # each _ pair {|key , val| . . . } -> YAML :: DBM (18910.0) -
自身のキーと値を引数としてブロックを評価します。
自身のキーと値を引数としてブロックを評価します。
自身を返します。 -
YAML
:: DBM # each _ value {|val| . . . } -> YAML :: DBM (18907.0) -
値を引数としてブロックを評価します。
値を引数としてブロックを評価します。
自身を返します。 -
YAML
:: DBM # replace(other) -> YAML :: DBM (18907.0) -
self の内容を other の内容で置き換えます。
self の内容を other の内容で置き換えます。
@param other Hash、DBM オブジェクトを指定します。
@raise DBMError 更新に失敗した場合に発生します。
自身を返します。 -
Psych
:: Handler # start _ document(version , tag _ directives , implicit) -> () (18724.0) -
YAML ドキュメントの始まりで呼び出されます。
YAML ドキュメントの始まりで呼び出されます。
version には YAML ドキュメントに宣言されているバージョンが
[major, minor] という配列で渡されます。宣言がない場合は空の配列が渡されます。
tag_directives には tag directive の配列が渡されます。
それぞれの tag は [prefix, suffix] という配列で表現されます。
implicit にはドキュメントが implicit に始まっているかどうかが
真偽値で渡されます。
必要に応じてこのメソッドを override してください。
@param version ... -
Gem
:: ConfigFile # load _ file(file _ name) -> object (18670.0) -
与えられたファイル名のファイルが存在すれば YAML ファイルとしてロードします。
与えられたファイル名のファイルが存在すれば YAML ファイルとしてロードします。
@param file_name YAML 形式で記述された設定ファイル名を指定します。 -
Gem
:: Package :: TarInput # load _ gemspec(io) -> Gem :: Specification | nil (18670.0) -
YAML 形式の gemspec を io から読み込みます。
YAML 形式の gemspec を io から読み込みます。
@param io 文字列か IO オブジェクトを指定します。
@see Gem::Specification.from_yaml -
Psych
:: Handler # end _ stream -> () (18652.0) -
YAML stream の終端を見付けたときに呼び出されます。
YAML stream の終端を見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。 -
Psych
:: Handler # end _ document(implicit) -> () (18640.0) -
ドキュメントが終了したときに呼び出されます。
ドキュメントが終了したときに呼び出されます。
ドキュメントが implicit に終わったならば implicit には真が渡されます。
必要に応じてこのメソッドを override してください。
@param implicit ドキュメントが implicit に終わったかどうか
=== 例
以下の YAML ドキュメントでは implicit は true です。
---
hello world
また、以下の YAML ドキュメントでは implicit は false です。
---
hello world
... -
YAML
:: DBM # invert -> {object => String} (18604.0) -
値からキーへのハッシュを返します。
値からキーへのハッシュを返します。
異なるキーに対して等しい値が登録されている場合の結果は不定であることに
注意してください、そのような場合にこのメソッドを利用することは意図され
ていません。 -
YAML
:: DBM # reject {|key , val| . . . } -> {String => object} (18604.0) -
ブロックを評価した値が真であれば該当する要素を削除します。
ブロックを評価した値が真であれば該当する要素を削除します。
新しく Hash オブジェクトを作成して返します。 -
Psych
:: Nodes :: Node # tag -> String | nil (18322.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 -
YAML
:: DBM # [](key) -> object | nil (18322.0) -
データベースからキーを探して対応する要素の値を返します。
データベースからキーを探して対応する要素の値を返します。
対応する値が見つからなかった場合は nil を返します。DBM#[] とは異
なり、IndexError は発生しません。
@param key キーを文字列で指定します。
@see YAML::DBM#fetch -
YAML
:: DBM # []=(key , value) -> object (18322.0) -
key に対して value を格納します。
key に対して value を格納します。
val で指定したオブジェクトを返します。
@param key キーを文字列で指定します。
@param value 値を指定します。YAML 形式に変換できるオブジェクトが指定で
きます。
@raise DBMError 要素の格納に失敗した場合に発生します。 -
YAML
:: DBM # fetch(key , ifnone = nil) -> object (18322.0) -
データベースからキーを探して対応する要素の値を返します。
データベースからキーを探して対応する要素の値を返します。
対応する値が見つからなかった場合は ifnone で指定した値を返します。
@param key キーを文字列で指定します。
@see YAML::DBM#[] -
YAML
:: DBM # has _ value?(value) -> bool (18322.0) -
value を値とする組がデータベース中に存在する時、真を返します。
value を値とする組がデータベース中に存在する時、真を返します。
@param value 検索したい値を指定します。YAML 形式に変換できるオブジェク
トが指定できます。 -
YAML
:: DBM # key(value) -> String | nil (18322.0) -
value を持つ要素のキーを返します。
value を持つ要素のキーを返します。
対応するキーが見つからなかった場合は nil を返します。
@param value 検索したい値を指定します。YAML 形式に変換できるオブジェク
トが指定できます。 -
YAML
:: DBM # select { . . . } -> [[String , object]] (18322.0) -
ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に 格納して返します。ブロックが与えられなかった場合は、keys に対応する値を 配列に格納して返します。
ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に
格納して返します。ブロックが与えられなかった場合は、keys に対応する値を
配列に格納して返します。
@param keys キーを文字列で指定します。複数指定することができます。
ブロックを与えるかどうかで戻り値が異なる事に注意してください。
@see YAML::DBM#values_at -
YAML
:: DBM # select(*keys) -> [object] (18322.0) -
ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に 格納して返します。ブロックが与えられなかった場合は、keys に対応する値を 配列に格納して返します。
ブロックを評価して真になった要素のみを [キー, 値] から構成される配列に
格納して返します。ブロックが与えられなかった場合は、keys に対応する値を
配列に格納して返します。
@param keys キーを文字列で指定します。複数指定することができます。
ブロックを与えるかどうかで戻り値が異なる事に注意してください。
@see YAML::DBM#values_at -
YAML
:: DBM # store(key , value) -> object (18322.0) -
key に対して value を格納します。
key に対して value を格納します。
val で指定したオブジェクトを返します。
@param key キーを文字列で指定します。
@param value 値を指定します。YAML 形式に変換できるオブジェクトが指定で
きます。
@raise DBMError 要素の格納に失敗した場合に発生します。 -
YAML
:: DBM # shift -> [String , object] (18304.0) -
データベース中のキー、値を一つ取り出し、データベースから削除します。
データベース中のキー、値を一つ取り出し、データベースから削除します。
[キー, 値]を返します。取得される要素の順番は保証されません。 -
YAML
:: DBM # to _ a -> [[String , object]] (18304.0) -
キーと値のペアを配列に変換して返します。
キーと値のペアを配列に変換して返します。 -
YAML
:: DBM # to _ hash -> Hash (18304.0) -
自身のキー、値をハッシュにしたものを返します。
自身のキー、値をハッシュにしたものを返します。 -
YAML
:: DBM # values -> object (18304.0) -
データベース中に存在する値全てを含む配列を返します。
データベース中に存在する値全てを含む配列を返します。 -
YAML
:: DBM # values _ at(*keys) -> [object] (18304.0) -
keys に対応する値を配列に格納して返します。
keys に対応する値を配列に格納して返します。
対応するキーが見つからなかった要素には nil が格納されます。
@param keys キーを文字列で指定します。複数指定することができます。 -
Psych
:: Handler # start _ stream(encoding) -> () (9670.0) -
YAML ストリームの始まりで呼び出されます。
YAML ストリームの始まりで呼び出されます。
encoding にはストリームのエンコーディング(以下のいずれか)が渡されます。
* Psych::Parser::UTF8
* Psych::Parser::UTF16BE
* Psych::Parser::UTF16LE
このメソッドは YAML のストリームごとに呼び出されます。一つのストリームには
複数のドキュメントが含まれている可能性があります。
必要に応じてこのメソッドを override してください。
@param encoding ストリームのエンコーディング(整数値) -
Psych
:: Visitors :: YAMLTree # start(encoding = Nodes :: Stream :: UTF8) -> Psych :: Nodes :: Stream (9670.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
:: Handler # scalar(value , anchor , tag , plain , quoted , style) -> () (9640.0) -
スカラー値を見付けたときに呼び出されます。
スカラー値を見付けたときに呼び出されます。
value にはスカラー値の文字列が渡されます。
anchor にはスカラー値に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。
tag にはスカラー値に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。
plain は plain style であるかどうか、quoted は quoted style であるかどうか
が渡されます。style には node の style が整数値で渡されます。
style は次の値のいずれか... -
Psych
:: Visitors :: YAMLTree # finish -> Psych :: Nodes :: Stream|nil (9604.0) -
変換を終了し、構築した AST を返します。
変換を終了し、構築した AST を返します。
このメソッドは2回呼び出さないでください。
@see Psych::Visitors::YAMLTree#tree -
Psych
:: Visitors :: YAMLTree # tree -> Psych :: Nodes :: Stream|nil (9604.0) -
変換を終了し、構築した AST を返します。
変換を終了し、構築した AST を返します。
内部で finish を呼び出し、変換処理を終了します。
このメソッドを2回以上呼ぶと、2回目以降は nil を返します。
@see Psych::Visitors::YAMLTree#finish -
Psych
:: Handler # start _ mapping(anchor , tag , implicit , style) -> () (9358.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 # start _ sequence(anchor , tag , implicit , style) -> () (9358.0) -
sequence の開始を見付けたときに呼び出されます。
sequence の開始を見付けたときに呼び出されます。
anchor には sequence に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。
tag には sequence に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。
implicit には sequence が implicit に開始されたかどうかが
真偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes:... -
Psych
:: Nodes :: Document # version -> [Integer] (9352.0) -
YAML ドキュメントのバージョンを返します。
YAML ドキュメントのバージョンを返します。
@see Psych::Nodes::Document#version=,
Psych::Nodes::Document.new -
RDoc
:: Options # write _ options -> object (9352.0) -
カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式 で保存します。
カレントディレクトリの .rdoc_options ファイルに指定した設定を YAML 形式
で保存します。 -
Psych
:: Handler # alias(anchor) -> () (9322.0) -
anchor という名前の alias を見付けたときに呼び出されます。
anchor という名前の alias を見付けたときに呼び出されます。
必要に応じてこのメソッドを override してください。
@param anchor aliasのアンカー文字列
=== 例
以下の YAMLドキュメントは自分自身への参照を持つ配列を表しています。
--- &ponies
- first element
- *ponies
この &ponies が anchor で *ponies が alias です。この場合、
alias メソッドは "poines" という引数で呼び出されます。 -
Psych
:: Stream # start(encoding = Psych :: Nodes :: Stream :: UTF8) -> Psych :: Stream (652.0) -
Ruby オブジェクトを YAML document に変換するための準備をします。
Ruby オブジェクトを YAML document に変換するための準備をします。
変換された document は Psych::Stream.new で指定した
出力先に出力されます。
finish を呼び出すことで出力が完了します(finish を呼び出さないと
最後まで出力されない場合があります)。
ブロック付きで start を呼び出すと、変換準備を終えた Stream オブジェクト
(self) がブロックに渡され、ブロックが呼び出された後に finish を呼び出します。
これによって finish を確実に呼び出すことができます。
@param encoding 出... -
Psych
:: Stream # start(encoding = Psych :: Nodes :: Stream :: UTF8) {|em| . . . } -> Psych :: Stream (652.0) -
Ruby オブジェクトを YAML document に変換するための準備をします。
Ruby オブジェクトを YAML document に変換するための準備をします。
変換された document は Psych::Stream.new で指定した
出力先に出力されます。
finish を呼び出すことで出力が完了します(finish を呼び出さないと
最後まで出力されない場合があります)。
ブロック付きで start を呼び出すと、変換準備を終えた Stream オブジェクト
(self) がブロックに渡され、ブロックが呼び出された後に finish を呼び出します。
これによって finish を確実に呼び出すことができます。
@param encoding 出...