struct HTTP::Headers

Overview

A Hash-like object that holds HTTP headers.

Two headers are considered the same if their downcase representation is the same (in which _ is the downcase version of -).

Included Modules

Defined in:

http/headers.cr

Constructors

Instance Method Summary

Macro Summary

Instance methods inherited from module Enumerable({String, Array(String)})

accumulate(initial : U) : Array(U) forall U
accumulate : Array({String, Array(String)})
accumulate(initial : U, &block : U, {String, Array(String)} -> U) : Array(U) forall U
accumulate(&block : {String, Array(String)}, {String, Array(String)} -> {String, Array(String)}) : Array({String, Array(String)})
accumulate
, all?(&)
all?(pattern) : Bool
all? : Bool
all?
, any?(&)
any?(pattern) : Bool
any? : Bool
any?
, chunks(&block : {String, Array(String)} -> U) forall U chunks, compact_map(&) compact_map, count(& : {String, Array(String)} -> _) : Int32
count(item) : Int32
count
, cycle(n, &)
cycle(&)
cycle
, each(&block : {String, Array(String)} -> ) each, each_cons(count : Int, reuse = false, &) each_cons, each_cons_pair(& : {String, Array(String)}, {String, Array(String)} -> _) : Nil each_cons_pair, each_slice(count : Int, reuse = false, &) each_slice, each_with_index(offset = 0, &) each_with_index, each_with_object(obj, &) each_with_object, empty? : Bool empty?, find(if_none = nil, &) find, first(&)
first(count : Int) : Array({String, Array(String)})
first : {String, Array(String)}
first
, first? : {String, Array(String)}? first?, flat_map(&block : {String, Array(String)} -> _) flat_map, group_by(&block : {String, Array(String)} -> U) forall U group_by, in_groups_of(size : Int, filled_up_with : U = nil) forall U
in_groups_of(size : Int, filled_up_with : U = nil, reuse = false, &) forall U
in_groups_of
, includes?(obj) : Bool includes?, index(& : {String, Array(String)} -> _) : Int32?
index(obj) : Int32?
index
, index_by(&block : {String, Array(String)} -> U) : Hash(U, {String, Array(String)}) forall U index_by, join(io : IO, separator = "") : Nil
join(separator, io : IO) : Nil
join(separator = "") : String
join(io : IO, separator = "", & : {String, Array(String)}, IO -> )
join(separator, io : IO, &)
join(separator = "", & : {String, Array(String)} -> )
join
, map(&block : {String, Array(String)} -> U) forall U map, map_with_index(offset = 0, &block : {String, Array(String)}, Int32 -> U) forall U map_with_index, max : {String, Array(String)} max, max? : {String, Array(String)}? max?, max_by(&block : {String, Array(String)} -> U) forall U max_by, max_by?(&block : {String, Array(String)} -> U) forall U max_by?, max_of(&block : {String, Array(String)} -> U) forall U max_of, max_of?(&block : {String, Array(String)} -> U) forall U max_of?, min : {String, Array(String)} min, min? : {String, Array(String)}? min?, min_by(&block : {String, Array(String)} -> U) forall U min_by, min_by?(&block : {String, Array(String)} -> U) forall U min_by?, min_of(&block : {String, Array(String)} -> U) forall U min_of, min_of?(&block : {String, Array(String)} -> U) forall U min_of?, minmax : Tuple({String, Array(String)}, {String, Array(String)}) minmax, minmax? : Tuple({String, Array(String)}?, {String, Array(String)}?) minmax?, minmax_by(&block : {String, Array(String)} -> U) forall U minmax_by, minmax_by?(&block : {String, Array(String)} -> U) forall U minmax_by?, minmax_of(&block : {String, Array(String)} -> U) forall U minmax_of, minmax_of?(&block : {String, Array(String)} -> U) forall U minmax_of?, none?(&)
none?(pattern) : Bool
none? : Bool
none?
, one?(&)
one?(pattern) : Bool
one? : Bool
one?
, partition(&) partition, product(initial : Number)
product
product(initial : Number, &)
product(&)
product
, reduce(memo, &)
reduce(&)
reduce
, reduce?(&) reduce?, reject(&block : {String, Array(String)} -> )
reject(type : U.class) forall U
reject(pattern) : Array({String, Array(String)})
reject
, sample(n : Int, random = Random::DEFAULT) : Array({String, Array(String)})
sample(random = Random::DEFAULT) : {String, Array(String)}
sample
, select(&block : {String, Array(String)} -> )
select(type : U.class) forall U
select(pattern) : Array({String, Array(String)})
select
, size : Int32 size, skip(count : Int) skip, skip_while(&) skip_while, sum(initial)
sum
sum(initial, &)
sum(&)
sum
, take_while(&) take_while, tally : Hash({String, Array(String)}, Int32) tally, to_a to_a, to_h
to_h(&block : {String, Array(String)} -> Tuple(K, V)) forall K, V
to_h
, to_set : Set({String, Array(String)}) to_set, zip(*others : Indexable | Iterable | Iterator, &)
zip(*others : Indexable | Iterable | Iterator)
zip
, zip?(*others : Indexable | Iterable | Iterator, &)
zip?(*others : Indexable | Iterable | Iterator)
zip?

Class methods inherited from module Enumerable({String, Array(String)})

element_type(x) element_type

Instance methods inherited from struct Struct

==(other) : Bool ==, hash(hasher) hash, inspect(io : IO) : Nil inspect, pretty_print(pp) : Nil pretty_print, to_s(io : IO) : Nil to_s

Instance methods inherited from struct Value

==(other : JSON::Any)
==(other : YAML::Any)
==(other)
==
, dup dup

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other)
===
, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash
hash
, in?(collection : Object) : Bool
in?(*values : Object) : Bool
in?
, inspect(io : IO) : Nil
inspect : String
inspect
, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String
to_json
, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil
to_pretty_json
, to_s(io : IO) : Nil
to_s : String
to_s
, to_yaml(io : IO) : Nil
to_yaml : String
to_yaml
, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

Class methods inherited from class Object

from_json(string_or_io, root : String)
from_json(string_or_io)
from_json
, from_yaml(string_or_io : String | IO) from_yaml

Constructor Detail

def self.new #

[View source]

Instance Method Detail

def ==(other : self) #

Equality operator.

Returns true if other is equal to self.

Keys are matched case-insensitive. String values are treated equal to an array values with the same string as single element.

HTTP::Headers{"Foo" => "bar"} == HTTP::Headers{"Foo" => "bar"}   # => true
HTTP::Headers{"Foo" => "bar"} == HTTP::Headers{"foo" => "bar"}   # => true
HTTP::Headers{"Foo" => "bar"} == HTTP::Headers{"Foo" => ["bar"]} # => true
HTTP::Headers{"Foo" => "bar"} == HTTP::Headers{"Foo" => "baz"}   # => false

[View source]
def [](key) : String #

[View source]
def []=(key, value : String) #

[View source]
def []=(key, value : Array(String)) #

[View source]
def []?(key) : String? #

[View source]
def add(key, value : String) : self #

[View source]
def add(key, value : Array(String)) : self #

[View source]
def add?(key, value : String) : Bool #

[View source]
def add?(key, value : Array(String)) : Bool #

[View source]
def clone #

[View source]
def delete(key) : String? #

[View source]
def dup #
Description copied from struct Value

Returns a shallow copy of this object.

Because Value is a value type, this method returns self, which already involves a shallow copy of this object because value types are passed by value.


[View source]
def each(&) #
Description copied from module Enumerable({String, Array(String)})

Must yield this collection's elements to the block.


[View source]
def empty? : Bool #
Description copied from module Enumerable({String, Array(String)})

Returns true if self is empty, false otherwise.

([] of Int32).empty? # => true
([1]).empty?         # => false

[View source]
def fetch(key, default) : String? #

[View source]
def fetch(key, &) #

[View source]
def get(key) : Array(String) #

[View source]
def get?(key) : Array(String)? #

[View source]
def has_key?(key) : Bool #

[View source]
def hash(hasher) #

[View source]
def includes_word?(key, word) : Bool #

Returns if among the headers for key there is some that contains word as a value. The word is expected to match between word boundaries (i.e. non-alphanumeric chars).

require "http/headers"

headers = HTTP::Headers{"Connection" => "keep-alive, Upgrade"}
headers.includes_word?("Connection", "Upgrade") # => true

[View source]
def inspect(io : IO) : Nil #
Description copied from struct Struct

Appends this struct's name and instance variables names and values to the given IO.

struct Point
  def initialize(@x : Int32, @y : Int32)
  end
end

p1 = Point.new 1, 2
p1.to_s    # "Point(@x=1, @y=2)"
p1.inspect # "Point(@x=1, @y=2)"

[View source]
def merge!(other) : self #

[View source]
def pretty_print(pp) #

[View source]
def same?(other : HTTP::Headers) : Bool #

[View source]
def to_s(io : IO) : Nil #
Description copied from struct Struct

Same as #inspect(io).


[View source]
def valid_value?(value) : Bool #

[View source]

Macro Detail

macro method_missing(call) #

[View source]