Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > yaml/dbmライブラリ > YAML::DBMクラス

class YAML::DBM

クラスの継承リスト: YAML::DBM < DBM < Enumerable < Object < Kernel < BasicObject

要約

DBM の値に文字列以外も格納できるように拡張したクラスです。

目次

インスタンスメソッド

[] []= store delete delete_if each each_pair each_value fetch has_value? index invert key reject replace select shift to_a to_hash update values values_at

定数

VERSION

インスタンスメソッド

self[key] -> object | nil[permalink][rdoc]

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

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

[PARAM] key:

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

[SEE_ALSO] YAML::DBM#fetch

self[key] = value[permalink][rdoc]

store(key, value) -> object

key に対して value を格納します。

val で指定したオブジェクトを返します。

[PARAM] key:

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

[PARAM] value:

値を指定します。YAML 形式に変換できるオブジェクトが指定で きます。

[EXCEPTION] DBMError:

要素の格納に失敗した場合に発生します。

delete(key) -> object | nil[permalink][rdoc]

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

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

[PARAM] key:

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

[EXCEPTION] DBMError:

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

delete_if {|key, val| ... } -> YAML::DBM[permalink][rdoc]

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

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

[EXCEPTION] DBMError:

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

each -> YAML::DBM[permalink][rdoc]

each_pair {|key, val| ... } -> YAML::DBM

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

自身を返します。

each_value {|val| ... } -> YAML::DBM[permalink][rdoc]

値を引数としてブロックを評価します。

自身を返します。

fetch(key, ifnone = nil) -> object[permalink][rdoc]

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

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

[PARAM] key:

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

[SEE_ALSO] YAML::DBM#[]

has_value?(value) -> bool[permalink][rdoc]

value を値とする組がデータベース中に存在する時、真を返します。

[PARAM] value:

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

index(value) -> String | nil[permalink][rdoc]

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

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

[PARAM] value:

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

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

[SEE_ALSO] YAML::DBM#key

invert -> {object => String}[permalink][rdoc]

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

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

key(value) -> String | nil[permalink][rdoc]

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

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

[PARAM] value:

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

reject {|key, val| ... } -> {String => object}[permalink][rdoc]

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

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

replace(other) -> YAML::DBM[permalink][rdoc]

self の内容を other の内容で置き換えます。

[PARAM] other:

Hash、DBM オブジェクトを指定します。

[EXCEPTION] DBMError:

更新に失敗した場合に発生します。

自身を返します。

select(*keys) -> [object][permalink][rdoc]

select { ... } -> [[String, object]]

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

[PARAM] keys:

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

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

[SEE_ALSO] YAML::DBM#values_at

shift -> [String, object][permalink][rdoc]

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

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

to_a -> [[String, object]][permalink][rdoc]

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

to_hash -> Hash[permalink][rdoc]

自身のキー、値をハッシュにしたものを返します。

update(other) -> self[permalink][rdoc]

自身と other の内容をマージ(統合)します。

重複するキーに対応する値は other の内容で上書きされます。

[PARAM] other:

Hash、DBM オブジェクトを指定します。

[EXCEPTION] DBMError:

更新に失敗した場合に発生します。

values -> object[permalink][rdoc]

データベース中に存在する値全てを含む配列を返します。

values_at(*keys) -> [object][permalink][rdoc]

keys に対応する値を配列に格納して返します。

対応するキーが見つからなかった要素には nil が格納されます。

[PARAM] keys:

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

定数

VERSION -> "0.1"[permalink][rdoc]

yaml/dbm のバージョンを文字列で返します。