Contents

require_relative 'response/error'

module Momento
  # A response containing the value retrieved from a cache.
  class GetResponse < Response
    # There was a value for the key.
    # @return [Boolean]
    def hit?
      false
    end

    # There was no value for the key.
    # @return [Boolean]
    def miss?
      false
    end

    # The gotten value, if any, as binary data: an ASCII_8BIT encoded frozen String.
    #
    # @return [String,nil] the value, if any, frozen and ASCII_8BIT encoded
    def value_bytes
      nil
    end

    # The gotten value, if any, as a string using your default encoding or specified one.
    #
    # @param encoding [Encoding] defaults to Encoding.default_external
    # @return [String,nil] the value, if any, re-encoded
    # rubocop:disable Lint/UnusedMethodArgument
    def value_string(encoding = Encoding.default_external)
      nil
    end
    # rubocop:enable Lint/UnusedMethodArgument

    # @!method to_s
    #   Displays the response and the value, if any.
    #   A long value will be truncated.
    #   @return [String]

    # @private
    class Hit < GetResponse
      # rubocop:disable Lint/MissingSuper
      def initialize(grpc_response:)
        @grpc_response = grpc_response
      end
      # rubocop:enable Lint/MissingSuper

      def hit?
        true
      end

      def value_bytes
        @grpc_response.cache_body
      end

      def value_string(encoding = Encoding.default_external)
        value_bytes.dup.force_encoding(encoding)
      end

      def to_s
        "#{super}: #{display_string(value_string)}"
      end
    end

    # @private
    class Miss < GetResponse
      def miss?
        true
      end
    end

    # @private
    class Error < GetResponse
      include Momento::Response::Error
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
momento-0.2.0	lib/momento/get_response.rb