Class: Browser::HTTP::Headers

Inherits:

Object

• Object
• Browser::HTTP::Headers

Includes:

Enumerable

Defined in:

opal/browser/http/headers.rb

Overview

Represents HTTP headers.

Instance Attribute Summary

• #length ⇒ Integer readonly

  The number of headers.

Class Method Summary

• .[](hash) ⇒ Object

  Create Headers from a hash.

• .parse(string) ⇒ Headers

  Parse HTTP headers from a string.

Instance Method Summary

• #<<(header) ⇒ self (also: #push)

  Push a header.

• #[](name) ⇒ String

  Get the value of a header.

• #[]=(name, value) ⇒ Object

  Set a value for the header.

• #clear ⇒ Object

  Clear the Headers.

• #each {|name, value| ... } ⇒ self

  Enumerate over the headers.

• #initialize ⇒ Headers constructor

  Create an empty Headers.

• #merge!(other) ⇒ self

  Merge in place other headers.

Constructor Details

#initialize ⇒ Headers

Create an empty Browser::HTTP::Headers.

# File 'opal/browser/http/headers.rb', line 32

def initialize
  @hash = Hash.new
end

Instance Attribute Details

#length ⇒ Integer (readonly)

Returns the number of headers.

Returns:

• (Integer) —

  the number of headers

# File 'opal/browser/http/headers.rb', line 104

def length
  @hash.length
end

Class Method Details

.[](hash) ⇒ Object

Create Browser::HTTP::Headers from a hash.

Parameters:

• hash (Hash)

# File 'opal/browser/http/headers.rb', line 19

def self.[](hash)
  result = new

  hash.each {|name, value|
    result[name] = value
  }

  result
end

.parse(string) ⇒ Headers

Parse HTTP headers from a string.

Parameters:

• string (String) —

  the whole HTTP headers response

Returns:

• (Headers) —

  the parsed headers

# File 'opal/browser/http/headers.rb', line 12

def self.parse(string)
  self[string.lines.map { |l| l.chomp.split(/\s*:\s*/) }]
end

Instance Method Details

#<<(header) ⇒ self Also known as: push

Push a header.

Parameters:

• header (Header) —

  the header to push

Returns:

• (self)

# File 'opal/browser/http/headers.rb', line 81

def <<(header)
  @hash[header.name.downcase] = header

  self
end

#[](name) ⇒ String

Get the value of a header.

Parameters:

• name (String) —

  the name of the header

Returns:

• (String) —

  the value of the header

# File 'opal/browser/http/headers.rb', line 62

def [](name)
  @hash[name.downcase]
end

#[]=(name, value) ⇒ Object

Set a value for the header.

Parameters:

• name (String) —

  the name of the header

• value (String) —

  the value of the header

# File 'opal/browser/http/headers.rb', line 70

def []=(name, value)
  header = Header.new(name, value)

  @hash[name.downcase] = header
end

#clear ⇒ Object

Clear the Browser::HTTP::Headers.

# File 'opal/browser/http/headers.rb', line 37

def clear
  @hash.clear
end

#each {|name, value| ... } ⇒ self

Enumerate over the headers.

Yield Parameters:

• name (String) —

  the name of the header

• value (String) —

  the value of the header

Returns:

• (self)

# File 'opal/browser/http/headers.rb', line 47

def each(&block)
  return enum_for :each unless block

  @hash.each {|_, header|
    block.call [header.name, header.value]
  }

  self
end

#merge!(other) ⇒ self

Merge in place other headers.

Parameters:

• other (Headers, Hash, #each) —

  the headers to merge

Returns:

• (self)

# File 'opal/browser/http/headers.rb', line 94

def merge!(other)
  other.each {|name, value|
    self[name] = value
  }

  self
end