class HTTP::Cookies
Overview
Represents a collection of cookies as it can be present inside a HTTP request or response.
Included Modules
Defined in:
http/cookie.crConstructors
- .from_client_headers(headers) : self
Creates a new instance by parsing the
Cookieheaders in the givenHTTP::Headers. - .from_headers(headers) : self
Creates a new instance by parsing the
CookieandSet-Cookieheaders in the givenHTTP::Headers.DEPRECATED Use
.from_client_headersor.from_server_headersinstead. - .from_server_headers(headers) : self
Creates a new instance by parsing the
Set-Cookieheaders in the givenHTTP::Headers. - .new
Creates a new empty instance.
Instance Method Summary
- #<<(cookie : Cookie)
Adds the given cookie to this collection, overrides an existing cookie with the same name if present.
- #[](key) : Cookie
Gets the current
HTTP::Cookiefor the given key. - #[]=(key, value : String)
Sets a new cookie in the collection with a string value.
- #[]=(key, value : Cookie)
Sets a new cookie in the collection to the given
HTTP::Cookieinstance. - #[]?(key) : Cookie?
Gets the current
HTTP::Cookiefor the given key ornilif none is set. - #add_request_headers(headers)
Adds
Cookieheaders for the cookies in this collection to the givenHTTP::Headersinstance and returns it. - #add_response_headers(headers)
Adds
Set-Cookieheaders for the cookies in this collection to the givenHTTP::Headersinstance and returns it. - #clear : Hash(String, HTTP::Cookie)
Clears the collection, removing all cookies.
- #delete(key) : Cookie?
Deletes and returns the
HTTP::Cookiefor the specified key, or returnsnilif key cannot be found in the collection. - #each(& : Cookie -> )
Yields each
HTTP::Cookiein the collection. - #each
Returns an iterator over the cookies of this collection.
- #empty? : Bool
Whether the collection contains any cookies.
- #fill_from_client_headers(headers) : self
Filling cookies by parsing the
Cookieheaders in the givenHTTP::Headers. - #fill_from_headers(headers)
Filling cookies by parsing the
CookieandSet-Cookieheaders in the givenHTTP::Headers.DEPRECATED Use
#fill_from_client_headersor#fill_from_server_headersinstead. - #fill_from_server_headers(headers) : self
Filling cookies by parsing the
Set-Cookieheaders in the givenHTTP::Headers. - #has_key?(key) : Bool
Returns
trueif a cookie with the given key exists. - #size : Int32
Returns the number of cookies contained in this collection.
- #to_h : Hash(String, Cookie)
Returns this collection as a plain
Hash.
Instance methods inherited from module Enumerable(HTTP::Cookie)
accumulate(initial : U) : Array(U) forall Uaccumulate : Array(T)
accumulate(initial : U, &block : U, T -> U) : Array(U) forall U
accumulate(&block : T, T -> T) : Array(T) accumulate, all?(& : T -> ) : Bool
all?(pattern) : Bool
all? : Bool all?, any?(& : T -> ) : Bool
any?(pattern) : Bool
any? : Bool any?, chunks(&block : T -> U) forall U chunks, compact_map(& : T -> _) compact_map, count(& : T -> ) : Int32
count(item) : Int32 count, cycle(n, & : T -> ) : Nil
cycle(& : T -> ) : Nil cycle, each(& : T -> ) each, each_cons(count : Int, reuse = false, &) each_cons, each_cons_pair(& : T, T -> ) : Nil each_cons_pair, each_slice(count : Int, reuse = false, &) each_slice, each_with_index(offset = 0, &) each_with_index, each_with_object(obj : U, & : T, U -> ) : U forall U each_with_object, empty? : Bool empty?, find(if_none = nil, & : T -> ) find, first(&)
first(count : Int) : Array(T)
first : T first, first? : T? first?, flat_map(& : T -> _) flat_map, group_by(& : T -> 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(& : T -> ) : Int32?
index(obj) : Int32? index, index_by(& : T -> U) : Hash(U, T) forall U index_by, join(io : IO, separator = "") : Nil
join(separator, io : IO) : Nil
join(separator = "") : String
join(io : IO, separator = "", & : T, IO -> )
join(separator, io : IO, &)
join(separator = "", & : T -> ) join, map(& : T -> U) : Array(U) forall U map, map_with_index(offset = 0, & : T, Int32 -> U) : Array(U) forall U map_with_index, max : T max, max? : T? max?, max_by(& : T -> U) : T forall U max_by, max_by?(& : T -> U) : T? forall U max_by?, max_of(& : T -> U) : U forall U max_of, max_of?(& : T -> U) : U? forall U max_of?, min : T min, min? : T? min?, min_by(& : T -> U) : T forall U min_by, min_by?(& : T -> U) : T? forall U min_by?, min_of(& : T -> U) : U forall U min_of, min_of?(& : T -> U) : U? forall U min_of?, minmax : Tuple(T, T) minmax, minmax? : Tuple(T?, T?) minmax?, minmax_by(& : T -> U) : Tuple(T, T) forall U minmax_by, minmax_by?(& : T -> U) : Tuple(T, T) | Tuple(Nil, Nil) forall U minmax_by?, minmax_of(& : T -> U) : Tuple(U, U) forall U minmax_of, minmax_of?(& : T -> U) : Tuple(U, U) | Tuple(Nil, Nil) forall U minmax_of?, none?(& : T -> ) : Bool
none?(pattern) : Bool
none? : Bool none?, one?(& : T -> ) : Bool
one?(pattern) : Bool
one? : Bool one?, partition(& : T -> ) : Tuple(Array(T), Array(T)) partition, product(initial : Number)
product
product(initial : Number, & : T -> )
product(& : T -> _) product, reduce(memo, &)
reduce(&) reduce, reduce?(&) reduce?, reject(& : T -> )
reject(type : U.class) forall U
reject(pattern) : Array(T) reject, sample(n : Int, random = Random::DEFAULT) : Array(T)
sample(random = Random::DEFAULT) : T sample, select(& : T -> )
select(type : U.class) : Array(U) forall U
select(pattern) : Array(T) select, size : Int32 size, skip(count : Int) skip, skip_while(& : T -> ) : Array(T) skip_while, sum(initial)
sum
sum(initial, & : T -> )
sum(& : T -> ) sum, take_while(& : T -> ) : Array(T) take_while, tally : Hash(T, Int32) tally, tally_by(& : T -> U) : Hash(U, Int32) forall U tally_by, to_a to_a, to_h
to_h(& : T -> Tuple(K, V)) forall K, V to_h, to_set : Set(T) 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(HTTP::Cookie)
element_type(x) element_type Instance methods inherited from class Reference
==(other : self)==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference) : Bool
same?(other : Nil) same?, to_s(io : IO) : Nil to_s
Constructor methods inherited from class Reference
new new 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.from_client_headers(headers) : selfSource
Creates a new instance by parsing the Cookie headers in the given HTTP::Headers.
def self.from_headers(headers) : selfSource
Creates 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.
DEPRECATED Use .from_client_headers or .from_server_headers instead.
def self.from_server_headers(headers) : selfSource
Creates a new instance by parsing the Set-Cookie headers in the given HTTP::Headers.
def self.newSource
Creates a new empty instance.
Instance Method Detail
def <<(cookie : Cookie)Source
Adds the given cookie to this collection, overrides an existing cookie with the same name if present.
response.cookies << HTTP::Cookie.new("foo", "bar", http_only: true) def [](key) : CookieSource
Gets the current HTTP::Cookie for the given key.
request.cookies["foo"].value # => "bar"
def []=(key, value : String)Source
Sets 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 no path.
require "http/client" request = HTTP::Request.new "GET", "/" request.cookies["foo"] = "bar"
def []=(key, value : Cookie)Source
Sets a new cookie in the collection to the given HTTP::Cookie instance. The name attribute must match the given key, else ArgumentError is raised.
require "http/client"
response = HTTP::Client::Response.new(200)
response.cookies["foo"] = HTTP::Cookie.new("foo", "bar", "/admin", Time.utc + 12.hours, secure: true) def []?(key) : Cookie?Source
Gets the current HTTP::Cookie for the given key or nil if none is set.
require "http/client" request = HTTP::Request.new "GET", "/" request.cookies["foo"]? # => nil request.cookies["foo"] = "bar" request.cookies["foo"]?.try &.value # > "bar"
def add_request_headers(headers)Source
Adds Cookie headers for the cookies in this collection to the given HTTP::Headers instance and returns it. Removes any existing Cookie headers in it.
def add_response_headers(headers)Source
Adds Set-Cookie headers for the cookies in this collection to the given HTTP::Headers instance and returns it. Removes any existing Set-Cookie headers in it.
def clear : Hash(String, HTTP::Cookie)Source
Clears the collection, removing all cookies.
def delete(key) : Cookie?Source
Deletes and returns the HTTP::Cookie for the specified key, or returns nil if key cannot be found in the collection. Note that key should match the name attribute of the desired HTTP::Cookie.
def each(& : Cookie -> )Source
Yields each HTTP::Cookie in the collection.
def eachSource
Returns an iterator over the cookies of this collection.
def fill_from_client_headers(headers) : selfSource
Filling cookies by parsing the Cookie headers in the given HTTP::Headers.
def fill_from_headers(headers)Source
Filling cookies by parsing the Cookie and Set-Cookie headers in the given HTTP::Headers.
DEPRECATED Use #fill_from_client_headers or #fill_from_server_headers instead.
def fill_from_server_headers(headers) : selfSource
Filling cookies by parsing the Set-Cookie headers in the given HTTP::Headers.
def has_key?(key) : BoolSource
Returns true if a cookie with the given key exists.
request.cookies.has_key?("foo") # => true
© 2012–2021 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/1.2.1/HTTP/Cookies.html