Ruby 2.1.0 リファレンスマニュアル > ライブラリ一覧 > 組み込みライブラリ > ENVオブジェクト

object ENV

クラス・モジュールの継承リスト: ENV
extend: Enumerable

要約

環境変数を表すオブジェクト。Hash と同様のインターフェースを持ちます。ただし、Hash と異なり、ENV のキーと値には文字列しかとることができません。

ENV で得られる文字列は ENV['PATH'] 以外は常に汚染されています。オブジェクトの汚染に関しては セキュリティモデル を参照して下さい。 ENV['PATH'] はその要素が誰でも書き込み可能なディレクトリを含んでいる場合に限り汚染されます。



p ENV['TERM'].tainted?  # => true
p path = ENV['PATH']    # => "/usr/local/bin:/usr/bin:/bin:/usr/X11/bin"
p path.tainted?         # => false

また、ENV で得られる文字列は Object#freeze されています。



p ENV['TERM'].frozen?  # => true

Windows では環境変数は大文字、小文字を区別しません。(cygwin を除く)



ENV['OS'] # => Windows_NT
ENV['os'] # => Windows_NT

特異メソッド

定義 説明
self[key] -> String

key に対応する環境変数の値を返します。該当する環境変数が存在しない時には nil を返します。

self[key] = value
store(key, value) -> String

key に対応する環境変数の値を value にします。 value が nil の時、key に対応する環境変数を取り除きます。

assoc(key) -> Array | nil

自身が与えられたキーに対応する要素を持つとき、見つかった要素のキーと値のペアを配列として返します。

clear -> self

環境変数をすべてクリアします。self を返します。

clone(freeze: true) -> object

ENV オブジェクトの複製を作成して返します。

delete(key) -> String | nil
delete(key) {|key| ... } -> String | nil

key に対応する環境変数を取り除きます。取り除かれた環境変数の値を返しますが、key に対応する環境変数が存在しない時には nil を返します。

delete_if {|key, value| ... } -> ENV
reject! {|key, value| ... } -> ENV | nil
delete_if -> Enumerator
reject! -> Enumerator

key と value を引数としてブロックを評価した値が真である時、環境変数を削除します。

each -> Enumerator
each_pair -> Enumerator
each {|key, value| ... } -> self
each_pair {|key, value| ... } -> self

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

each_key -> Enumerator
each_key {|key| ... } -> self

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

each_value -> Enumerator
each_value {|value| ... } -> self

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

empty? -> bool

環境変数がひとつも定義されていない時真を返します。

fetch(key) -> String
fetch(key, default) -> String
fetch(key) {|key| ... } -> String

key に関連づけられた値を返します。該当するキーが登録されていない時には、引数 default が与えられていればその値を、ブロックが与えられていればそのブロックを評価した値を返します。そのいずれでもなければ例外が発生します。

has_key?(key) -> bool
include?(key) -> bool
key?(key) -> bool
member?(key) -> bool

key で指定される環境変数が存在する時、真を返します。

has_value?(val) -> bool
value?(val) -> bool

val を値として持つ環境変数が存在する時、真を返します。

key(val) -> String | nil
index(val) -> String | nil

val に対応するキーを返します。対応する要素が存在しない時には nil を返します。

inspect -> String

ENV オブジェクトを文字列化します。 Hash#inspect と同じように動作します。

invert -> Hash

環境変数の値をキー、名前を値とした Hash を生成して返します。

keep_if {|key, value| ... } -> ENV
select! {|key, value| ... } -> ENV | nil
keep_if -> Enumerator
select! -> Enumerator

キーと値を引数としてブロックを評価した結果が真であるような要素を環境変数に残します。

keys -> [String]

全環境変数の名前の配列を返します。

length -> Integer
size -> Integer

環境変数の数を返します。

rassoc(value) -> Array | nil

自身が与えられた値に対応する要素を持つとき、見つかった要素のキーと値のペアを配列として返します。

rehash -> nil

何もしません。nilを返します。

reject -> Enumerator
reject {|key, value| ... } -> Hash

環境変数のうち、ブロックを評価した値が真であるものをとり除きます。 Enumerable#reject と異なり Hash を返します。また、とり除いた結果は実際の環境変数に影響を与えません。

replace(hash) -> ENV

環境変数を hash と同じ内容に変更します。 self を返します。

select -> Enumerator
select {|key, value| ... } -> Hash

環境変数名と値についてブロックを評価し、真を返したものを集めたハッシュを返します。

shift -> [String, String] | nil

環境変数を一つ取り除いて、それを名前と値の組の配列で返します。環境変数が一つも設定されていなければ nil を返します。

to_a -> [[String, String]]

環境変数から [変数名, 値] となる 2 要素の配列の配列を生成します。

to_h -> Hash

環境変数の名前をキーとし、対応する値をもつハッシュを返します。

to_hash -> Hash

環境変数の名前をキーとし、対応する値をもつハッシュを返します。

to_s -> String

環境変数を文字列化します。 Hash#to_s と同じように動作します。

update(other) -> ENV
update(other) {|key, self_val, other_val| ... } -> ENV

ハッシュ other の内容を環境変数にマージします。重複するキーに対応する値は other の内容で上書きされます。

values -> [String]

環境変数の全値の配列を返します。

values_at(*key) -> [String]

引数で指定されたキー(環境変数名)に対応する値の配列を返します。存在しないキーに対しては nil が対応します。