module ENV

Overview

ENV is a hash-like accessor for environment variables.

Example

Assuming the following example is invoked with the HOST=localhost and PORT=5000 environment variables:

p ENV["HOST"]                       # => "localhost"
p ENV["PORT"].to_i                  # => 5000
p ENV.fetch("TLS_PORT", "443").to_i # => 443

NOTE All keys and values are strings. You must take care to cast other types at runtime, e.g. integer port numbers.

Safety

Modifying the environment in single-threaded programs is safe. Modifying the environment is also always safe on Windows.

Modifying the environment in multi-threaded programs on other targets is always unsafe, and can cause a mere read to segfault! At best, memory will be leaked every time the environment is modified.

The problem is that POSIX systems don't guarantee a thread safe implementation of the getenv, setenv and putenv libc functions. Any thread that gets an environment variable while another thread sets an environment variable may segfault. The Crystal runtime implementation of ENV itself is protected by a readers-writer lock, but we can't protect against external libraries, including libc calls made by the stdlib, to call getenv internally without holding the read lock while a crystal fiber with the write lock calls setenv.

The only safe solution is to consider ENV to be immutable, and to never call ENV.[]=, ENV.delete or ENV.clear in your programs. If you really need to, you must make sure that no other thread has been started (beware of libraries that may start threads without your knowledge).

NOTE Passing environment variables to a child process should use the env arg of Process.run and Process.new.

Extended Modules

• Enumerable({String, String})

Defined in:

Class Method Summary

• .[](key : String) : String

  Retrieves the value for environment variable named key as a String.

• .[]=(key : String, value : String | Nil)

  Sets the value for environment variable named key as value.

• .[]?(key : String) : String | Nil

  Retrieves the value for environment variable named key as a String?.

• .clear : Nil

  WARNING It is recommended to never delete environment variables.

• .delete(key : String) : String | Nil

  Removes the environment variable named key.

• .each(& : Tuple(String, String) -> )

  Iterates over all KEY=VALUE pairs of environment variables, yielding both the key and value.

• .fetch(key, default : T) : String | T forall T

  Retrieves a value corresponding to the given key.

• .fetch(key) : String

  Retrieves a value corresponding to the given key.

• .fetch(key : String, &block : String -> T) : String | T forall T

  Retrieves a value corresponding to a given key.

• .has_key?(key : String) : Bool

  Returns true if the environment variable named key exists and false if it doesn't.

• .inspect(io)

  Writes the contents of the environment to io.

• .keys : Array(String)

  Returns an array of all the environment variable names.

• .pretty_print(pp)
• .values : Array(String)

  Returns an array of all the environment variable values.

Class Method Detail

ENV.each do |key, value|
  puts "#{key} => #{value}"
end

ENV.has_key?("NOT_A_REAL_KEY") # => false
ENV.has_key?("PATH")           # => true