Class: HTTPX::Plugins::Cookie

Inherits:

Object

• Object
• HTTPX::Plugins::Cookie

Includes:

Comparable

Defined in:

sig/plugins/cookies/cookie.rbs

Defined Under Namespace

Modules: Scanner

Constant Summary

MAX_LENGTH =

Returns:

• (Integer)

Instance Attribute Summary

• #created_at ⇒ Time readonly

  Returns the value of attribute created_at.

• #domain ⇒ DomainName^? readonly

  Returns the value of attribute domain.

• #name ⇒ String readonly

  Returns the value of attribute name.

• #path ⇒ String readonly

  Returns the value of attribute path.

• #value ⇒ String^? readonly

  Returns the value of attribute value.

Class Method Summary

• .new ⇒ Object
• .path_match? ⇒ Boolean

Instance Method Summary

• #acceptable_from_uri? ⇒ Boolean
• #cookie_value ⇒ String
• #domain ⇒ void readonly
• #expired? ⇒ Object
• #expires ⇒ Time^?
• #initialize ⇒ Cookie constructor

  A new instance of Cookie.

• #match? ⇒ Boolean
• #path ⇒ void readonly
• #valid_for_uri? ⇒ Boolean

Constructor Details

#initialize ⇒ Cookie

Returns a new instance of Cookie.

Parameters:

• name (_ToS)
• value (_ToS)
• (cookie_attributes)

# File 'sig/plugins/cookies/cookie.rbs', line 46

def initialize: (_ToS name, _ToS value, ?cookie_attributes) -> void

Instance Attribute Details

#created_at ⇒ Time (readonly)

Returns the value of attribute created_at.

Returns:

• (Time)

# File 'sig/plugins/cookies/cookie.rbs', line 16

def created_at
  @created_at
end

#domain ⇒ DomainName^? (readonly)

Returns the value of attribute domain.

Returns:

• (DomainName, nil)

# File 'sig/plugins/cookies/cookie.rbs', line 8

def domain
  @domain
end

#name ⇒ String (readonly)

Returns the value of attribute name.

Returns:

• (String)

# File 'sig/plugins/cookies/cookie.rbs', line 12

def name
  @name
end

#path ⇒ String (readonly)

Returns the value of attribute path.

Returns:

• (String)

# File 'sig/plugins/cookies/cookie.rbs', line 10

def path
  @path
end

#value ⇒ String^? (readonly)

Returns the value of attribute value.

Returns:

• (String, nil)

# File 'sig/plugins/cookies/cookie.rbs', line 14

def value
  @value
end

Class Method Details

.new(arg0) ⇒ instance .new(arg0) ⇒ instance .new(arg0, arg1, arg2) ⇒ instance

Overloads:

• .new(arg0) ⇒ instance

  Parameters:

  • arg0 (Cookie)

  Returns:

  • (instance)
• .new(arg0) ⇒ instance

  Parameters:

  • arg0 (cookie_attributes)

  Returns:

  • (instance)
• .new(arg0, arg1, arg2) ⇒ instance

  Parameters:

  • arg0 (_ToS)
  • arg1 (_ToS)
  • arg2 (cookie_attributes)

  Returns:

  • (instance)

# File 'sig/plugins/cookies/cookie.rbs', line 38

def self.new: (Cookie) -> instance
| (cookie_attributes) -> instance
| (_ToS, _ToS, ?cookie_attributes) -> instance

.path_match? ⇒ Boolean

Parameters:

• (String)
• (String)

Returns:

• (Boolean)

# File 'sig/plugins/cookies/cookie.rbs', line 42

def self.path_match?: (String, String) -> bool

Instance Method Details

#acceptable_from_uri? ⇒ Boolean

Parameters:

• (uri)

Returns:

• (Boolean)

# File 'sig/plugins/cookies/cookie.rbs', line 48

def acceptable_from_uri?: (uri) -> bool

#cookie_value ⇒ String

Returns:

• (String)

# File 'sig/plugins/cookies/cookie.rbs', line 31

def cookie_value: () -> String

#domain= ⇒ void (readonly)

This method returns an undefined value.

Parameters:

• (string)

# File 'sig/plugins/cookies/cookie.rbs', line 24

def domain=: (string) -> void

#expired? ⇒ Boolean #expired?(arg0) ⇒ Boolean

Overloads:

• #expired? ⇒ Boolean

  Returns:

  • (Boolean)
• #expired?(arg0) ⇒ Boolean

  Parameters:

  • arg0 (Time)

  Returns:

  • (Boolean)

# File 'sig/plugins/cookies/cookie.rbs', line 28

def expired?: () -> bool
| (Time) -> bool

#expires ⇒ Time^?

Returns:

• (Time, nil)

# File 'sig/plugins/cookies/cookie.rbs', line 26

def expires: () -> Time?

#match? ⇒ Boolean

Parameters:

• name_or_options (String, cookie_attributes)

Returns:

• (Boolean)

# File 'sig/plugins/cookies/cookie.rbs', line 34

def match?: (String | cookie_attributes name_or_options) -> bool

#path= ⇒ void (readonly)

This method returns an undefined value.

Parameters:

• (string)

# File 'sig/plugins/cookies/cookie.rbs', line 22

def path=: (string) -> void

#valid_for_uri? ⇒ Boolean

Parameters:

• uri (http_uri)

Returns:

• (Boolean)

# File 'sig/plugins/cookies/cookie.rbs', line 36

def valid_for_uri?: (http_uri uri) -> bool