class HTTP::Cookies


Represents a collection of cookies as it can be present inside a HTTP request or response.

Included Modules

Defined in:


Class Method Summary

Instance Method Summary

Instance methods inherited from module Enumerable(T)

, any?
, compact_map(&block) compact_map, count(item)
, cycle(&block)
cycle(n, &block)
, each(&block : T -> _) each, each_cons(count : Int, &block) each_cons, each_slice(count : Int, &block) each_slice, each_with_index(offset = 0, &block) each_with_index, each_with_object(obj, &block) each_with_object, find(if_none = nil, &block) find, first first, first? first?, flat_map(&block : T -> Array(U)) flat_map, grep(pattern) grep, group_by(&block : T -> U) group_by, in_groups_of(size : Int, filled_up_with = nil, &block)
in_groups_of(size : Int, filled_up_with = nil)
, includes?(obj) includes?, index(obj)
, index_by(&block : T -> U) index_by, join(separator = "")
join(separator, io, &block)
join(separator = "", &block)
join(separator, io)
, map(&block : T -> U) map, map_with_index(&block : T, Int32 -> U) map_with_index, max max, max? max?, max_by(&block : T -> U) max_by, max_by?(&block : T -> U) max_by?, max_of(&block : T -> U) max_of, max_of?(&block : T -> U) max_of?, min min, min? min?, min_by(&block : T -> U) min_by, min_by?(&block : T -> U) min_by?, min_of(&block : T -> U) min_of, min_of?(&block : T -> U) min_of?, minmax minmax, minmax? minmax?, minmax_by(&block : T -> U) minmax_by, minmax_by?(&block : T -> U) minmax_by?, minmax_of(&block : T -> U) minmax_of, minmax_of?(&block : T -> U) minmax_of?, none?(&block)
, one?(&block) one?, partition(&block) partition, reduce(&block)
reduce(memo, &block)
, reject(&block : T -> ) reject, select(&block : T -> ) select, size size, skip(count : Int) skip, skip_while(&block) skip_while, sum(initial, &block)
, take(count : Int) take, take_while(&block) take_while, to_a to_a, to_h to_h, to_set to_set

Instance methods inherited from class Reference

! !, ==(other)
==(other : self)
, hash hash, inspect(io : IO) : Nil inspect, nil? nil?, object_id object_id, same?(other : Nil)
same?(other : Reference)
, to_s(io : IO) : Nil to_s

Instance methods inherited from class Object

! !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other) ===, =~(other) =~, class class, clone clone, crystal_type_id crystal_type_id, dup dup, hash hash, inspect
inspect(io : IO)
, itself itself, not_nil! not_nil!, tap(&block) tap, to_json to_json, to_pretty_json(io : IO)
, to_s
to_s(io : IO)
, to_yaml(io : IO)
, try(&block) try

Class methods inherited from class Object

==(other : Class) ==, ===(other) ===, cast(other) : self cast, from_json(string_or_io) from_json, from_yaml(string : String) from_yaml, hash hash, inspect(io) inspect, name : String name, to_s(io) to_s

Class Method Detail

def self.from_headers(headers) #

Create a new instance by parsing the Cookie and Set-Cookie headers in the given HTTP::Headers.

See HTTP::Request#cookies and HTTP::Client::Response#cookies.

[View source]
def #

Create a new empty instance

[View source]

Instance Method Detail

def <<(cookie : Cookie) #

Add the given cookie to this collection, overrides an existing cookie with the same name if present.

response.cookies <<"foo", "bar", http_only: true)

[View source]
def [](key) #

Get the current HTTP::Cookie for the given key.

request.cookies["foo"].value # => "bar"

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

Set a new cookie in the collection with a string value. This creates a never expiring, insecure, not HTTP only cookie with no explicit domain restriction and the path /.

request.cookies["foo"] = "bar"

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

Set a new cookie in the collection to the given HTTP::Cookie instance. The name attribute must match the given key, else ArgumentError is raised.

response.cookies["foo"] ="foo", "bar", "/admin", + 12.hours, secure: true)

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

Get the current HTTP::Cookie for the given key or nil if none is set.

request.cookies["foo"]? # => nil
request.cookies["foo"] = "bar"
request.cookies["foo"]?.try &.value # > "bar"

[View source]
def add_request_headers(headers) #

Adds Cookie headers for the cookies in this collection to the given HTTP::Header instance and returns it. Removes any existing Cookie headers in it.

[View source]
def add_response_headers(headers) #

Adds Set-Cookie headers for the cookies in this collection to the given HTTP::Header instance and returns it. Removes any existing Set-Cookie headers in it.

[View source]
def each #

Returns an iterator over the cookies of this collection.

[View source]
def each(&block : T -> _) #

Yields each HTTP::Cookie in the collection.

[View source]
def has_key?(key) #

Returns true if a cookie with the given key exists.

request.cookies.has_key?("foo") #=> true

[View source]
def to_h #

Returns this collection as a plain Hash.

[View source]