Class: ActiveSupport::Cache::NullStore
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Store
|
|
Instance Chain:
self,
Strategy::LocalCache ,
Store
|
|
Inherits: |
ActiveSupport::Cache::Store
|
Defined in: | activesupport/lib/active_support/cache/null_store.rb |
Overview
Null Cache Store
A cache store implementation which doesn’t actually store anything. Useful in development and test environments where you don’t want caching turned on but need to go through the caching interface.
This cache does implement the local cache strategy, so values will actually be cached inside blocks that utilize this strategy. See Strategy::LocalCache
for more details.
Constant Summary
Store
- Inherited
Class Attribute Summary
-
.supports_cache_versioning? ⇒ Boolean
readonly
Advertise cache versioning support.
Store
- Inherited
Class Method Summary
Store
- Inherited
.new | Creates a new cache. |
.retrieve_pool_options |
Instance Attribute Summary
Store
- Inherited
Instance Method Summary
- #cleanup(options = nil)
- #clear(options = nil)
- #decrement(name, amount = 1, options = nil)
- #delete_matched(matcher, options = nil)
- #increment(name, amount = 1, options = nil)
- #delete_entry(key, **options) private
- #read_entry(key, **s) private
- #read_serialized_entry(_key) private
- #write_entry(key, entry) private
- #write_serialized_entry(_key, _payload) private
- #inspect Internal use only
Strategy::LocalCache
- Included
#middleware | Middleware class can be inserted as a |
#with_local_cache | Use a local cache for the duration of block. |
#bypass_local_cache, #delete_entry, #local_cache, #local_cache_key, #read_multi_entries, #read_serialized_entry, #use_temporary_local_cache, #write_cache_value, #write_serialized_entry, #cleanup, #clear, #decrement, #delete_matched, #increment |
Store
- Inherited
#cleanup | Cleans up the cache by removing expired entries. |
#clear | Clears the entire cache. |
#decrement | Decrements an integer value in the cache. |
#delete | Deletes an entry in the cache. |
#delete_matched | Deletes all entries with keys matching the pattern. |
#delete_multi | Deletes multiple entries in the cache. |
#exist? | Returns |
#fetch | Fetches data from the cache, using the given key. |
#fetch_multi | Fetches data from the cache, using the given keys. |
#increment | Increments an integer value in the cache. |
#mute | Silences the logger within a block. |
#read | Reads data from the cache, using the given key. |
#read_multi | Reads multiple values at once from the cache. |
#silence, | |
#silence! | Silences the logger. |
#write | Writes the value to the cache with the key. |
#write_multi |
|
#_instrument, #default_serializer, | |
#delete_entry | Deletes an entry from the cache implementation. |
#delete_multi_entries | Deletes multiples entries in the cache implementation. |
#deserialize_entry, | |
#expanded_key | Expands key to be a consistent string value. |
#expanded_version, #get_entry_value, #handle_expired_entry, #handle_invalid_expires_in, #instrument, #instrument_multi, | |
#key_matcher | Adds the namespace defined in the options to a pattern designed to match keys. |
#merged_options | Merges the default options with ones specific to a method call. |
#namespace_key | Prefix the key with a namespace string: |
#normalize_key | Expands and namespaces the cache key. |
#normalize_options | Normalize aliased options to their canonical form. |
#normalize_version, | |
#read_entry | Reads an entry from the cache implementation. |
#read_multi_entries | Reads multiple entries from the cache implementation. |
#save_block_result_to_cache, #serialize_entry, #validate_options, | |
#write_entry | Writes an entry to the cache implementation. |
#write_multi_entries | Writes multiple entries to the cache implementation. |
#new_entry |
Constructor Details
This class inherits a constructor from ActiveSupport::Cache::Store
Class Attribute Details
.supports_cache_versioning? ⇒ Boolean
(readonly)
Advertise cache versioning support.
# File 'activesupport/lib/active_support/cache/null_store.rb', line 18
def self.supports_cache_versioning? true end
Instance Method Details
#cleanup(options = nil)
[ GitHub ]# File 'activesupport/lib/active_support/cache/null_store.rb', line 25
def cleanup( = nil) end
#clear(options = nil)
[ GitHub ]# File 'activesupport/lib/active_support/cache/null_store.rb', line 22
def clear( = nil) end
#decrement(name, amount = 1, options = nil)
[ GitHub ]# File 'activesupport/lib/active_support/cache/null_store.rb', line 31
def decrement(name, amount = 1, = nil) end
#delete_entry(key, **options) (private)
[ GitHub ]# File 'activesupport/lib/active_support/cache/null_store.rb', line 57
def delete_entry(key, ** ) false end
#delete_matched(matcher, options = nil)
[ GitHub ]# File 'activesupport/lib/active_support/cache/null_store.rb', line 34
def delete_matched(matcher, = nil) end
#increment(name, amount = 1, options = nil)
[ GitHub ]# File 'activesupport/lib/active_support/cache/null_store.rb', line 28
def increment(name, amount = 1, = nil) end
#inspect
# File 'activesupport/lib/active_support/cache/null_store.rb', line 37
def inspect # :nodoc: "#<#{self.class.name} options=#{@options.inspect}>" end
#read_entry(key, **s) (private)
[ GitHub ]# File 'activesupport/lib/active_support/cache/null_store.rb', line 42
def read_entry(key, **s) deserialize_entry(read_serialized_entry(key)) end
#read_serialized_entry(_key) (private)
[ GitHub ]# File 'activesupport/lib/active_support/cache/null_store.rb', line 46
def read_serialized_entry(_key, **) end
#write_entry(key, entry) (private)
[ GitHub ]# File 'activesupport/lib/active_support/cache/null_store.rb', line 49
def write_entry(key, entry, **) write_serialized_entry(key, serialize_entry(entry)) end
#write_serialized_entry(_key, _payload) (private)
[ GitHub ]# File 'activesupport/lib/active_support/cache/null_store.rb', line 53
def write_serialized_entry(_key, _payload, **) true end