Contents

require 'grpc'
require_relative 'response/error'
require_relative 'error'
require_relative 'error/grpc_details'
require_relative 'error/transport_details'
require_relative 'error_builder'
require_relative 'response_builder'
require_relative 'create_cache_response'
require_relative 'create_cache_response_builder'
require_relative 'delete_response'
require_relative 'delete_response_builder'
require_relative 'delete_cache_response'
require_relative 'delete_cache_response_builder'
require_relative 'get_response'
require_relative 'get_response_builder'
require_relative 'list_caches_response'
require_relative 'list_caches_response_builder'
require_relative 'set_response'
require_relative 'set_response_builder'

module Momento
  # The response from a Momento service request.
  #
  # {Momento::SimpleCacheClient} returns a response for both success
  # and error, as well as other states. See the documenation for each
  # type of response for more.
  #
  # You can always check for an error response with
  # `response.error?` and get the error itself with `response.error`.
  #
  # `response.error` is an Exception and can be raised. It contains
  # additional information about the error, see {Momento::Error} for
  # more information.
  #
  # @see Momento::Error
  class Response
    MAX_STRING_DISPLAY_LENGTH = 32
    private_constant :MAX_STRING_DISPLAY_LENGTH

    # Returns the error portion of the response, if any.
    #
    # @return [Momento::Error, nil]
    def error
      nil
    end

    # Is the response an error?
    #
    # @return [Boolean]
    def error?
      false
    end

    # Displays the type of response and additional info, if any.
    # @return [String]
    def to_s
      self.class.to_s
    end

    protected

    def display_string(string, max_length: MAX_STRING_DISPLAY_LENGTH)
      if string.length < max_length
        string
      else
        "#{string[0, max_length]}..."
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

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