class ActionDispatch::Http::Headers

Parent:: Object
Included modules:: Enumerable

Provides access to the request's HTTP headers from the environment.

env     = { "CONTENT_TYPE" => "text/plain" }
headers = ActionDispatch::Http::Headers.new(env)
headers["Content-Type"] # => "text/plain"

Constants

CGI_VARIABLES
HTTP_HEADER

Attributes

env[R]

Public Instance Methods

[](key) Show source

# File actionpack/lib/action_dispatch/http/headers.rb, line 40
def [](key)
  @env[env_name(key)]
end

Returns the value for the given key mapped to @env.

[]=(key, value) Show source

# File actionpack/lib/action_dispatch/http/headers.rb, line 45
def []=(key, value)
  @env[env_name(key)] = value
end

Sets the given value for the key mapped to @env.

each(&block) Show source

# File actionpack/lib/action_dispatch/http/headers.rb, line 65
def each(&block)
  @env.each(&block)
end

fetch(key, *args, &block) Show source

# File actionpack/lib/action_dispatch/http/headers.rb, line 61
def fetch(key, *args, &block)
  @env.fetch env_name(key), *args, &block
end

Returns the value for the given key mapped to @env.

If the key is not found and an optional code block is not provided, raises a KeyError exception.

If the code block is provided, then it will be run and its result returned.

include?(key)

Alias for: key?

key?(key) Show source

# File actionpack/lib/action_dispatch/http/headers.rb, line 49
def key?(key)
  @env.key? env_name(key)
end

Also aliased as: include?

merge(headers_or_env) Show source

# File actionpack/lib/action_dispatch/http/headers.rb, line 71
def merge(headers_or_env)
  headers = Http::Headers.new(env.dup)
  headers.merge!(headers_or_env)
  headers
end

Returns a new Http::Headers instance containing the contents of headers_or_env and the original instance.

merge!(headers_or_env) Show source

# File actionpack/lib/action_dispatch/http/headers.rb, line 80
def merge!(headers_or_env)
  headers_or_env.each do |key, value|
    self[env_name(key)] = value
  end
end

Adds the contents of headers_or_env to original instance entries; duplicate keys are overwritten with the values from headers_or_env.