class HTTP::Cookie
Overview
Represents a cookie with all its attributes. Provides convenient access and modification of them.
Defined in:
http/cookie.crConstructors
- .new(name : String, value : String, path : String? = nil, expires : Time? = nil, domain : String? = nil, secure : Bool = false, http_only : Bool = false, samesite : SameSite? = nil, extension : String? = nil, max_age : Time::Span? = nil, creation_time = Time.utc)
Creates a new
Cookieinstance.
Instance Method Summary
- #==(other : self)
Returns
trueif this reference is the same as other. - #creation_time : Time
- #domain : String?
- #domain=(domain : String?)
- #expiration_time : Time?
Returns the expiration time of this cookie.
- #expired?(time_reference = Time.utc) : Bool
Returns the expiration status of this cookie as a
Bool. - #expires : Time?
- #expires=(expires : Time?)
- #extension : String?
- #extension=(extension : String?)
- #hash(hasher)
- #http_only : Bool
- #http_only=(http_only : Bool)
- #max_age : Time::Span?
- #max_age=(max_age : Time::Span?)
- #name : String
- #name=(name : String)
Sets the name of this cookie.
- #path : String?
- #path=(path : String?)
- #samesite : SameSite?
- #samesite=(samesite : SameSite?)
- #secure : Bool
- #secure=(secure : Bool)
- #to_cookie_header(io) : Nil
- #to_cookie_header : String
- #to_set_cookie_header : String
- #value : String
- #value=(value : String)
Sets the value of this cookie.
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.new(name : String, value : String, path : String? = nil, expires : Time? = nil, domain : String? = nil, secure : Bool = false, http_only : Bool = false, samesite : SameSite? = nil, extension : String? = nil, max_age : Time::Span? = nil, creation_time = Time.utc)Source
Creates a new Cookie instance.
Raises IO::Error if name or value are invalid as per RFC 6265 §4.1.1.
Instance Method Detail
def ==(other : self)
Returns true if this reference is the same as other. Invokes same?.
def hash(hasher)
def max_age : Time::Span?Source
def max_age=(max_age : Time::Span?)Source
def name=(name : String)Source
Sets the name of this cookie.
Raises IO::Error if the value is invalid as per RFC 6265 §4.1.1.
def value=(value : String)Source
Sets the value of this cookie.
Raises IO::Error if the value is invalid as per RFC 6265 §4.1.1.
© 2012–2021 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/1.2.1/HTTP/Cookie.html