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
- Enumerable({String, Array(String)})
Defined in:
http/headers.crConstructors
Instance Method Summary
- #==(other : Hash)
- #==(other : self)
- #[](key)
- #[]=(key, value : String)
- #[]=(key, value : Array(String))
- #[]?(key)
- #add(key, value : String)
- #add(key, value : Array(String))
- #add?(key, value : String)
- #add?(key, value : Array(String))
- #clone
- #delete(key)
-
#dup
Returns a shallow copy of this object.
-
#each(&)
Must yield this collection's elements to the block.
-
#empty?
Returns
true
ifself
is empty,false
otherwise. - #fetch(key, &)
- #fetch(key, default)
- #get(key)
- #get?(key)
- #has_key?(key)
-
#includes_word?(key, word)
Returns if among the headers for key there is some that contains word as a value.
-
#inspect(io : IO) : Nil
Appends this struct's name and instance variables names and values to the given IO.
- #merge!(other)
- #pretty_print(pp)
- #same?(other : HTTP::Headers)
-
#to_s(io : IO) : Nil
Same as
#inspect(io)
. - #valid_value?(value)
Macro Summary
Instance methods inherited from module Enumerable({String, Array(String)})
all?(&)all?(pattern)
all? all?, any?(&)
any?(pattern)
any? any?, chunks(&block : {String, Array(String)} -> U) forall U chunks, compact_map(&) compact_map, count(&)
count(item) count, cycle(&)
cycle(n, &) 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? empty?, find(if_none = nil, &) find, first(&)
first(count : Int)
first first, first? first?, flat_map(&block : {String, Array(String)} -> Array(U) | Iterator(U) | U) forall U flat_map, grep(pattern) grep, 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) includes?, index(&)
index(obj) index, index_by(&block : {String, Array(String)} -> U) forall U index_by, join(separator = "", & : {String, Array(String)} -> )
join(separator, io : IO, &)
join(io : IO, separator = "", & : {String, Array(String)}, IO -> )
join(separator = "")
join(separator, io : IO)
join(io : IO, separator = "") 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 max, max? 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 min, min? 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 minmax, minmax? 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)
none?(&) none?, one?(&)
one?(pattern)
one? one?, partition(&) partition, product
product(initial : Number)
product(initial : Number, &)
product(&) product, reduce(memo, &)
reduce(&) reduce, reduce?(&) reduce?, reject(pattern)
reject(type : U.class) forall U
reject(&block : {String, Array(String)} -> ) reject, select(pattern)
select(type : U.class) forall U
select(&block : {String, Array(String)} -> ) select, size 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 to_set, zip(*others : Indexable | Iterable | Iterator, &)
zip(*others : Indexable | Iterable | Iterator) zip, zip?(*others : Indexable | Iterable | Iterator, &)
zip?(*others : Indexable | Iterable | Iterator) zip?
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?(*values : Object) : Bool
in?(collection) : Bool in?, inspect : String
inspect(io : IO) : Nil 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)
to_json to_json, to_pretty_json(io : IO, indent : String = " ")
to_pretty_json(indent : String = " ") to_pretty_json, to_s : String
to_s(io : IO) : Nil to_s, to_yaml(io : IO)
to_yaml 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
Instance Method Detail
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.
Returns true
if self
is empty, false
otherwise.
([] of Int32).empty? # => true
([1]).empty? # => false
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
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)"