Module: FFI::MsgPack

Extended by:

Library

Defined in:

lib/ffi/msgpack/zone.rb,
lib/ffi/msgpack/types.rb,
lib/ffi/msgpack/packer.rb,
lib/ffi/msgpack/msg_map.rb,
lib/ffi/msgpack/msg_raw.rb,
lib/ffi/msgpack/msgpack.rb,
lib/ffi/msgpack/packable.rb,
lib/ffi/msgpack/unpacker.rb,
lib/ffi/msgpack/msg_array.rb,
lib/ffi/msgpack/msg_object.rb,
lib/ffi/msgpack/msg_key_value.rb,
lib/ffi/msgpack/zone_finalizer.rb,
lib/ffi/msgpack/zone_chunk_list.rb,
lib/ffi/msgpack/msg_object_union.rb,
lib/ffi/msgpack/zone_finalizer_array.rb,
lib/ffi/msgpack/exceptions/parse_error.rb

Defined Under Namespace

Modules: Packable Classes: MsgArray, MsgKeyValue, MsgMap, MsgObject, MsgObjectUnion, MsgRaw, Packer, ParseError, Unpacker, Zone, ZoneChunkList, ZoneFinalizer, ZoneFinalizerArray

Class Method Summary

• .pack(obj) ⇒ String

  Packs a Ruby object.

• .unpack(packed) ⇒ Hash, ...

  Unpacks a packed object.

Class Method Details

.pack(obj) ⇒ String

Packs a Ruby object.

Parameters:

• obj (Hash, Array, String, Symbol, Integer, Float, true, false, nil) —

  The Ruby object to pack.

Returns:

• (String) —

  The packed Ruby object.

# File 'lib/ffi/msgpack/msgpack.rb', line 103

def MsgPack.pack(obj)
  packer = Packer.create
  packer << obj

  return packer.to_s
end

.unpack(packed) ⇒ Hash, ...

Unpacks a packed object.

Parameters:

• packed (String) —

  The packed object.

Returns:

• (Hash, Array, String, Symbol, Integer, Float, true, false, nil) —

  The first unpacked Ruby object.

# File 'lib/ffi/msgpack/msgpack.rb', line 119

def MsgPack.unpack(packed)
  unpacker = Unpacker.create(packed.length)
  unpacker << packed

  return unpacker.first
end