Class: ActiveSupport::Cache::Entry

### Home Classes Methods

### In Files

- lib/active_support/cache.rb

### Parent

Object

### Methods

- ::create
- ::new
- #compressed?
- #expired?
- #expires_at
- #expires_at=
- #raw_value
- #size
- #value

### Class/Module Index

Quicksearch

- ActiveSupport
- ActiveSupport::Autoload
- ActiveSupport::BacktraceCleaner
- ActiveSupport::Base64
- ActiveSupport::BasicObject
- ActiveSupport::Benchmarkable
- ActiveSupport::BufferedLogger
- ActiveSupport::BufferedLogger::Severity
- ActiveSupport::Cache
- ActiveSupport::Cache::Entry
- ActiveSupport::Cache::FileStore
- ActiveSupport::Cache::MemCacheStore
- ActiveSupport::Cache::MemoryStore
- ActiveSupport::Cache::NullStore
- ActiveSupport::Cache::Store
- ActiveSupport::Cache::Strategy
- ActiveSupport::Cache::Strategy::LocalCache
- ActiveSupport::Cache::Strategy::LocalCache::LocalStore
- ActiveSupport::Callbacks
- ActiveSupport::Callbacks::ClassMethods
- ActiveSupport::Concern
- ActiveSupport::Configurable
- ActiveSupport::Configurable::ClassMethods
- ActiveSupport::Configurable::Configuration
- ActiveSupport::Dependencies
- ActiveSupport::Dependencies::ClassCache
- ActiveSupport::Dependencies::WatchStack
- ActiveSupport::Deprecation
- ActiveSupport::DescendantsTracker
- ActiveSupport::Duration
- ActiveSupport::FileUpdateChecker
- ActiveSupport::FileWatcher
- ActiveSupport::FileWatcher::Backend
- ActiveSupport::Gzip
- ActiveSupport::Gzip::Stream
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::Inflector
- ActiveSupport::Inflector::Inflections
- ActiveSupport::InheritableOptions
- ActiveSupport::JSON
- ActiveSupport::JSON::Encoding
- ActiveSupport::JSON::Encoding::CircularReferenceError
- ActiveSupport::JSON::Encoding::Encoder
- ActiveSupport::JSON::Variable
- ActiveSupport::LogSubscriber
- ActiveSupport::LogSubscriber::TestHelper
- ActiveSupport::LogSubscriber::TestHelper::MockLogger
- ActiveSupport::Memoizable
- ActiveSupport::Memoizable::InstanceMethods
- ActiveSupport::MessageEncryptor
- ActiveSupport::MessageEncryptor::InvalidMessage
- ActiveSupport::MessageVerifier
- ActiveSupport::MessageVerifier::InvalidSignature
- ActiveSupport::Multibyte
- ActiveSupport::Multibyte::Chars
- ActiveSupport::Multibyte::EncodingError
- ActiveSupport::Multibyte::Unicode
- ActiveSupport::Multibyte::Unicode::Codepoint
- ActiveSupport::Multibyte::Unicode::UnicodeDatabase
- ActiveSupport::Notifications
- ActiveSupport::Notifications::Event
- ActiveSupport::Notifications::Fanout
- ActiveSupport::Notifications::Instrumenter
- ActiveSupport::OrderedHash
- ActiveSupport::OrderedOptions
- ActiveSupport::Railtie
- ActiveSupport::Rescuable
- ActiveSupport::Rescuable::ClassMethods
- ActiveSupport::SafeBuffer
- ActiveSupport::SafeBuffer::SafeConcatError
- ActiveSupport::StringInquirer
- ActiveSupport::TaggedLogging
- ActiveSupport::TestCase
- ActiveSupport::Testing
- ActiveSupport::Testing::Assertions
- ActiveSupport::Testing::Declarative
- ActiveSupport::Testing::Isolation
- ActiveSupport::Testing::Isolation::Forking
- ActiveSupport::Testing::Isolation::MiniTest
- ActiveSupport::Testing::Isolation::Subprocess
- ActiveSupport::Testing::Isolation::TestUnit
- ActiveSupport::Testing::Pending
- ActiveSupport::Testing::Performance
- ActiveSupport::Testing::Performance::Benchmarker
- ActiveSupport::Testing::Performance::ForClassicTestUnit
- ActiveSupport::Testing::Performance::ForMiniTest
- ActiveSupport::Testing::Performance::Metrics
- ActiveSupport::Testing::Performance::Metrics::Amount
- ActiveSupport::Testing::Performance::Metrics::Base
- ActiveSupport::Testing::Performance::Metrics::CpuTime
- ActiveSupport::Testing::Performance::Metrics::DigitalInformationUnit
- ActiveSupport::Testing::Performance::Metrics::GcRuns
- ActiveSupport::Testing::Performance::Metrics::GcTime
- ActiveSupport::Testing::Performance::Metrics::Memory
- ActiveSupport::Testing::Performance::Metrics::Objects
- ActiveSupport::Testing::Performance::Metrics::ProcessTime
- ActiveSupport::Testing::Performance::Metrics::Time
- ActiveSupport::Testing::Performance::Metrics::UserTime
- ActiveSupport::Testing::Performance::Metrics::WallTime
- ActiveSupport::Testing::Performance::Performer
- ActiveSupport::Testing::Performance::Profiler
- ActiveSupport::Testing::ProxyTestResult
- ActiveSupport::Testing::RemoteError
- ActiveSupport::Testing::SetupAndTeardown
- ActiveSupport::Testing::SetupAndTeardown::ClassMethods
- ActiveSupport::Testing::SetupAndTeardown::ForClassicTestUnit
- ActiveSupport::Testing::SetupAndTeardown::ForMiniTest
- ActiveSupport::TimeWithZone
- ActiveSupport::TimeZone
- ActiveSupport::XmlMini
- ActiveSupport::XmlMini_LibXMLSAX
- ActiveSupport::XmlMini_LibXMLSAX::HashBuilder
- ActiveSupport::XmlMini_NokogiriSAX
- ActiveSupport::XmlMini_NokogiriSAX::HashBuilder
- Test
- Test::Unit
- Test::Unit::Collector
- Test::Unit::Collector::ObjectSpace
- Object
- Object::HashWithIndifferentAccess
- Object::MissingSourceFile
- ERB
- ERB::Util
- I18n
- I18n::Railtie
- LoadError
- LoadError
- Logger
- Logger::SimpleFormatter
- Array
- Base64
- Benchmark
- BigDecimal
- Class
- Date
- DateTime
- Enumerable
- FalseClass
- File
- Float
- Hash
- Integer
- Kernel
- Module
- NameError
- NilClass
- Numeric
- Process
- QualifiedConstUtils
- Range
- Regexp
- String
- Symbol
- Time
- TrueClass
- URI

No matching classes.

# ActiveSupport::Cache::Entry

Entry that is put into caches. It supports expiration time on entries and can compress values to save space in the cache.

### Constants

DEFAULT_COMPRESS_LIMIT

### Attributes

created_at[R]
expires_in[R]

### Public Class Methods

create(raw_value, created_at, options = {}) click to toggle source

Create an entry with internal attributes set. This method is intended to be used by implementations that store cache entries in a native format instead of as serialized Ruby objects.

    # File lib/active_support/cache.rb, line 541
    def create(raw_value, created_at, options = {})
      entry = new(nil)
      entry.instance_variable_set(:@value, raw_value)
      entry.instance_variable_set(:@created_at, created_at.to_f)
      entry.instance_variable_set(:@compressed, options[:compressed])
      entry.instance_variable_set(:@expires_in, options[:expires_in])
      entry
    end

new(value, options = {}) click to toggle source

Create a new cache entry for the specified value. Options supported are `:compress`, `:compress_threshold`, and `:expires_in`.

    # File lib/active_support/cache.rb, line 553
    def initialize(value, options = {})
      @compressed = false
      @expires_in = options[:expires_in]
      @expires_in = @expires_in.to_f if @expires_in
      @created_at = Time.now.to_f
      if value.nil?
        @value = nil
      else
        @value = Marshal.dump(value)
        if should_compress?(@value, options)
          @value = Zlib::Deflate.deflate(@value)
          @compressed = true
        end
      end
    end

### Public Instance Methods

compressed?() click to toggle source

    # File lib/active_support/cache.rb, line 594
    def compressed?
      @compressed
    end

expired?() click to toggle source

Check if the entry is expired. The `expires_in` parameter can override the value set when the entry was created.

    # File lib/active_support/cache.rb, line 600
    def expired?
      @expires_in && @created_at + @expires_in <= Time.now.to_f
    end

expires_at() click to toggle source

Seconds since the epoch when the entry will expire.

    # File lib/active_support/cache.rb, line 614
    def expires_at
      @expires_in ? @created_at + @expires_in : nil
    end

expires_at=(time) click to toggle source

Set a new time when the entry will expire.

    # File lib/active_support/cache.rb, line 605
    def expires_at=(time)
      if time
        @expires_in = time.to_f - @created_at
      else
        @expires_in = nil
      end
    end

raw_value() click to toggle source

Get the raw value. This value may be serialized and compressed.

    # File lib/active_support/cache.rb, line 570
    def raw_value
      @value
    end

size() click to toggle source

Returns the size of the cached value. This could be less than value.size if the data is compressed.

    # File lib/active_support/cache.rb, line 620
    def size
      if @value.nil?
        0
      else
        @value.bytesize
      end
    end

value() click to toggle source

Get the value stored in the cache.

    # File lib/active_support/cache.rb, line 575
    def value
      # If the original value was exactly false @value is still true because
      # it is marshalled and eventually compressed. Both operations yield
      # strings.
      if @value
        # In rails 3.1 and earlier values in entries did not marshaled without
        # options[:compress] and if it's Numeric.
        # But after commit a263f377978fc07515b42808ebc1f7894fafaa3a
        # all values in entries are marshalled. And after that code below expects
        # that all values in entries will be marshaled (and will be strings).
        # So here we need a check for old ones.
        begin
          Marshal.load(compressed? ? Zlib::Inflate.inflate(@value) : @value)
        rescue TypeError
          compressed? ? Zlib::Inflate.inflate(@value) : @value
        end
      end
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.