Module: Kobako::Codec::Encoder

Defined in:
lib/kobako/codec/encoder.rb,
sig/kobako/codec/encoder.rbs

Overview

Module-level entry point for the host side of the kobako wire (docs/wire-codec.md § Type Mapping).

The codec backbone is the official msgpack gem: integers, floats, strings, arrays, and maps go through the gem's narrowest-encoding logic; the three kobako-specific ext types (0x00 Symbol, 0x01 Capability Handle, 0x02 Exception envelope) are registered by ExtTypes on the process-wide factory.

Public API is a single function — .encode. The codec is stateless; there is no buffer accumulator and no streaming write API. Callers that need to concatenate multiple encodings build the bytes themselves.

Class Method Summary collapse

Class Method Details

.encode(value) ⇒ String

Encode value to wire bytes (binary-encoded String). SPEC's 12-entry type mapping is a closed set: a value outside it is rejected as UnsupportedType by the factory's BasicObject guard (ExtTypes#register_unrepresentable), which raises before the msgpack gem can route the value through to_msgpack — so a permissive method_missing object cannot answer that probe and mis-encode. The rescue below maps the two violations the guard does not reach onto the same error: an integer outside i64..u64 (+RangeError+) and any packer-internal NoMethodError.

Parameters:

  • value (Object)

Returns:

  • (String) 


33
34
35
36
37
 
# File 'lib/kobako/codec/encoder.rb', line 33

def self.encode(value)
  FACTORY.dump(value)
rescue ::RangeError, ::NoMethodError => e
  raise UnsupportedType, e.message
end