Muriel-Salvan/ruby-serial

require 'English'
require 'msgpack'
require 'ruby-serial/_class'
require 'ruby-serial/_object'
require 'ruby-serial/common'
require 'ruby-serial/serializer'
require 'ruby-serial/deserializer'

# Namespace encapsulating the API and whole library
module RubySerial

  # Serialize an object into a String
  #
  # Parameters::
  # * *obj* (_Object_): Object to serialize
  # * *options* (<em>map<Symbol,Object></em>): Options [default = {}]
  #   * *:version* (_String_): The version to be used to encode
  # Result::
  # * _String_: Serialized object
  def self.dump(obj, options = {})
    Serializer.new(obj, options).dump
  end

  # Deserialize an object from a String
  #
  # Parameters::
  # * *data* (_String_): Data to deserialize
  # Result::
  # * _Object_: Corresponding Ruby object
  def self.load(data)
    Deserializer.new(data).load
  end

end