Class: Temporalio::PayloadConverter::EncodingBase Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/temporalio/payload_converter/encoding_base.rb

Overview

This class is abstract.

Use this Interface for implementing an encoding payload converter. This is used as a converter for the Composite.

Direct Known Subclasses

Bytes, JSON, Nil

Instance Method Summary collapse

Instance Method Details

#encoding ⇒ String

A mime-type for the converter’s encoding.

Returns:

  • (String)

Raises:

  • (NoMethodError) 


11
12
13
 
# File 'lib/temporalio/payload_converter/encoding_base.rb', line 11

def encoding
  raise NoMethodError, 'must implement #encoding'
end

#from_payload(_payload) ⇒ any

Convert a proto Payload to a Ruby value.

Parameters:

Returns:

  • (any)

Raises:

  • (NoMethodError) 


30
31
32
 
# File 'lib/temporalio/payload_converter/encoding_base.rb', line 30

def from_payload(_payload)
  raise NoMethodError, 'must implement #from_payload'
end

#to_payload(_data) ⇒ Temporalio::Api::Common::V1::Payload?

Convert a Ruby value to a proto Payload.

Parameters:

  • _data (any) —

    Ruby value to be converted.

Returns:

Raises:

  • (NoMethodError) 


21
22
23
 
# File 'lib/temporalio/payload_converter/encoding_base.rb', line 21

def to_payload(_data)
  raise NoMethodError, 'must implement #to_payload'
end