Class: Karafka::Params::Params

Inherits:

Object

• Object
• Karafka::Params::Params

Extended by:

Forwardable

Defined in:

lib/karafka/params/params.rb

Overview

It provides lazy loading not only until the first usage, but also allows us to skip using deserializer until we execute our logic. That way we can operate with heavy-deserialization data without slowing down the whole application.

Instance Attribute Summary

• #metadata ⇒ Object readonly

  Returns the value of attribute metadata.

• #raw_payload ⇒ Object readonly

  Returns the value of attribute raw_payload.

Instance Method Summary

• #deserialized? ⇒ Boolean

  Did given params payload were deserialized already.

• #initialize(raw_payload, metadata) ⇒ Params constructor

  A new instance of Params.

• #payload ⇒ Object

  Lazy-deserialized data (deserialized upon first request).

Constructor Details

#initialize(raw_payload, metadata) ⇒ Params

# File 'lib/karafka/params/params.rb', line 18

def initialize(raw_payload, metadata)
  @raw_payload = raw_payload
  @metadata = metadata
  @deserialized = false
  @payload = nil
end

Instance Attribute Details

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.

# File 'lib/karafka/params/params.rb', line 12

def metadata
  @metadata
end

#raw_payload ⇒ Object (readonly)

Returns the value of attribute raw_payload.

# File 'lib/karafka/params/params.rb', line 12

def raw_payload
  @raw_payload
end

Instance Method Details

#deserialized? ⇒ Boolean

# File 'lib/karafka/params/params.rb', line 37

def deserialized?
  @deserialized
end

#payload ⇒ Object

# File 'lib/karafka/params/params.rb', line 26

def payload
  return @payload if deserialized?

  @payload = deserialize
  # We mark deserialization as successful after deserialization, as in case of an error
  # this won't be falsely set to true
  @deserialized = true
  @payload
end