Class: AnyCache::Adapters::Basic Private

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Dumper::InterfaceAccessMixin
Defined in:
lib/any_cache/adapters/basic.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Since:

  • 0.1.0

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Dumper::InterfaceAccessMixin

#detransform_pairset, #detransform_value, #transform_pairset, #transform_value

Constructor Details

#initialize(driver) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • driver (Object)

Since:

  • 0.1.0



34
35
36
# File 'lib/any_cache/adapters/basic.rb', line 34

def initialize(driver)
  @driver = driver
end

Instance Attribute Details

#driverObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Object)

Since:

  • 0.1.0



27
28
29
# File 'lib/any_cache/adapters/basic.rb', line 27

def driver
  @driver
end

Class Method Details

.supported_driver?(driver) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • driver (Object)

Returns:

  • (Boolean)

Since:

  • 0.1.0



18
19
20
# File 'lib/any_cache/adapters/basic.rb', line 18

def supported_driver?(driver)
  false
end

Instance Method Details

#cleanup(**options) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • options (Hash)

Raises:

  • (NotImplementedError)

Since:

  • 0.4.0



177
178
179
# File 'lib/any_cache/adapters/basic.rb', line 177

def cleanup(**options)
  raise NotImplementedError
end

#clear(**options) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • options (Hash)

Raises:

  • (NotImplementedError)

Since:

  • 0.1.0



168
169
170
# File 'lib/any_cache/adapters/basic.rb', line 168

def clear(**options)
  raise NotImplementedError
end

#decrement(key, value, **options) ⇒ Integer, Float

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • key (String)
  • value (Integer, Float)
  • options (Hash)

Returns:

  • (Integer, Float)

Raises:

  • (NotImplementedError)

Since:

  • 0.1.0



139
140
141
# File 'lib/any_cache/adapters/basic.rb', line 139

def decrement(key, value, **options)
  raise NotImplementedError
end

#delete(key, **options) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • key (String)
  • options (Hash)

Raises:

  • (NotImplementedError)

Since:

  • 0.1.0



107
108
109
# File 'lib/any_cache/adapters/basic.rb', line 107

def delete(key, **options)
  raise NotImplementedError
end

#delete_matched(pattern, **options) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • pattern (Regexp, String, Object)
  • options (Hash)

Raises:

  • (NotImplementedError)

Since:

  • 0.3.0



117
118
119
# File 'lib/any_cache/adapters/basic.rb', line 117

def delete_matched(pattern, **options)
  raise NotImplementedError
end

#exist?(key, **options) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • key (String)
  • options (Hash)

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError)

Since:

  • 0.2.0



187
188
189
# File 'lib/any_cache/adapters/basic.rb', line 187

def exist?(key, **options)
  raise NotImplementedError
end

#expire(key, expires_in:) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • key (String)
  • expires_in (Hash)

    a customizable set of options

Options Hash (expires_in:):

  • (Integer)

Raises:

  • (NotImplementedError)

Since:

  • 0.1.0



149
150
151
# File 'lib/any_cache/adapters/basic.rb', line 149

def expire(key, expires_in:)
  raise NotImplementedError
end

#fetch(key, **options, &fallback) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • key (String)
  • options (Hash)
  • fallback (Proc)

Returns:

  • (Object)

Raises:

  • (NotImplementedError)

Since:

  • 0.2.0



86
87
88
# File 'lib/any_cache/adapters/basic.rb', line 86

def fetch(key, **options, &fallback)
  raise NotImplementedError
end

#fetch_multi(*keys, **options, &fallback) ⇒ Hash

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • keys (Array<String>)
  • options (Hash)
  • fallback (Proc)

Returns:

  • (Hash)

Raises:

  • (NotImplementedError)

Since:

  • 0.3.0



97
98
99
# File 'lib/any_cache/adapters/basic.rb', line 97

def fetch_multi(*keys, **options, &fallback)
  raise NotImplementedError
end

#increment(key, value, **options) ⇒ Integer, Float

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • key (String)
  • value (Integer, Float)
  • options (Hash)

Returns:

  • (Integer, Float)

Raises:

  • (NotImplementedError)

Since:

  • 0.1.0



128
129
130
# File 'lib/any_cache/adapters/basic.rb', line 128

def increment(key, value, **options)
  raise NotImplementedError
end

#persist(key, **options) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • key (String)
  • options (Hash)

Raises:

  • (NotImplementedError)

Since:

  • 0.1.0



159
160
161
# File 'lib/any_cache/adapters/basic.rb', line 159

def persist(key, **options)
  raise NotImplementedError
end

#read(key, **options) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • key (String)
  • options (Hash)

Returns:

  • (Object)

Raises:

  • (NotImplementedError)

Since:

  • 0.1.0



44
45
46
# File 'lib/any_cache/adapters/basic.rb', line 44

def read(key, **options)
  raise NotImplementedError
end

#read_multi(*keys, **options) ⇒ Hash

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • keys (Array<String>)
  • options (Hash)

Returns:

  • (Hash)

Raises:

  • (NotImplementedError)

Since:

  • 0.3.0



54
55
56
# File 'lib/any_cache/adapters/basic.rb', line 54

def read_multi(*keys, **options)
  raise NotImplementedError
end

#write(key, value, **options) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • key (String)
  • value (Object)
  • options (Hash)

Raises:

  • (NotImplementedError)

Since:

  • 0.1.0



65
66
67
# File 'lib/any_cache/adapters/basic.rb', line 65

def write(key, value, **options)
  raise NotImplementedError
end

#write_multi(entries, **options) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

  • entries (Hash)
  • options (Hash)

Raises:

  • (NotImplementedError)

Since:

  • 0.3.0



75
76
77
# File 'lib/any_cache/adapters/basic.rb', line 75

def write_multi(entries, **options)
  raise NotImplementedError
end