msgpack 1.4.2 → 1.7.3

data/doclib/msgpack/core_ext.rb

@@ -1,101 +0,0 @@
-
-class NilClass
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class TrueClass
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class FalseClass
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class Fixnum < Integer
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class Bignum < Integer
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class Float < Numeric
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class String
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class Array
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class Hash
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-
-class Symbol
-  #
-  # Same as MessagePack.to_msgpack(self[, packer]).
-  #
-  # @return [String] serialized data
-  #
-  def to_msgpack(packer=nil)
-  end
-end
-

data/doclib/msgpack/error.rb

@@ -1,19 +0,0 @@
-module MessagePack
-
-  class UnpackError < StandardError
-  end
-
-  class MalformedFormatError < UnpackError
-  end
-
-  class StackError < UnpackError
-  end
-
-  class UnexpectedTypeError < UnpackError
-    include TypeError
-  end
-
-  class UnknownExtTypeError < UnpackError
-    include TypeError
-  end
-end

data/doclib/msgpack/extension_value.rb

@@ -1,9 +0,0 @@
-module MessagePack
-
-  #
-  # MessagePack::ExtensionValue is a struct to represent unknown ext type object.
-  # Its contents are accessed by type and payload (messagepack bytes representation) methods.
-  # And it is extended to add to_msgpack object.
-  #
-  ExtensionValue = Struct.new(:type, :payload)
-end

data/doclib/msgpack/factory.rb

@@ -1,101 +0,0 @@
-module MessagePack
-  #
-  # MessagePack::Factory is a class to generate Packer and Unpacker which has
-  # same set of ext types.
-  #
-  class Factory
-    #
-    # Creates a MessagePack::Factory instance
-    #
-    def initialize
-    end
-
-    #
-    # Creates a MessagePack::Packer instance, which has ext types already registered.
-    # Options are passed to MessagePack::Packer#initialized.
-    #
-    # See also Packer#initialize for options.
-    #
-    def packer(*args)
-    end
-
-    #
-    # Serialize the passed value
-    #
-    # If it could not serialize the object, it raises
-    # NoMethodError: undefined method `to_msgpack' for #<the_object>.
-    #
-    # @param obj [Object] object to serialize
-    # @param options [Hash]
-    # @return [String] serialized object
-    #
-    # See Packer#initialize for supported options.
-    #
-    def dump(obj, options={})
-    end
-    alias pack dump
-
-    #
-    # Creates a MessagePack::Unpacker instance, which has ext types already registered.
-    # Options are passed to MessagePack::Unpacker#initialized.
-    #
-    # See also Unpacker#initialize for options.
-    #
-    def unpacker(*args)
-    end
-
-    #
-    # Deserializes an object from the string or io and returns it.
-    #
-    # If there're not enough data to deserialize one object, this method raises EOFError.
-    # If data format is invalid, this method raises MessagePack::MalformedFormatError.
-    # If the object nests too deeply, this method raises MessagePack::StackError.
-    #
-    # @param data [String]
-    # @param options [Hash]
-    # @return [Object] deserialized object
-    #
-    # See Unpacker#initialize for supported options.
-    #
-    def load(data, options={})
-    end
-    alias unpack load
-
-    #
-    # Register a type and Class to be registered for packer and/or unpacker.
-    # If options are not speicified, factory will use :to_msgpack_ext for packer, and
-    # :from_msgpack_ext for unpacker.
-    #
-    # @param type [Fixnum] type id of registered Class (0-127)
-    # @param klass [Class] Class to be associated with type id
-    # @param options [Hash] specify method name or Proc which are used by packer/unpacker
-    # @return nil
-    #
-    # Supported options:
-    #
-    # * *:packer* specify symbol or proc object for packer
-    # * *:unpacker* specify symbol or proc object for unpacker
-    #
-    def register_type(type, klass, options={})
-    end
-
-    #
-    # Returns a list of registered types, ordered by type id.
-    #
-    # @param selector [Symbol] specify to list types registered for :packer, :unpacker or :both (default)
-    # @return Array
-    #
-    def registered_types(selector=:both)
-    end
-
-    #
-    # Returns true/false which indicate specified class or type id is registered or not.
-    #
-    # @param klass_or_type [Class or Fixnum] Class or type id (0-127) to be checked
-    # @param selector [Symbol] specify to check for :packer, :unpacker or :both (default)
-    # @return true or false
-    #
-    def type_registered?(klass_or_type, selector=:both)
-    end
-  end
-end

data/doclib/msgpack/packer.rb

@@ -1,208 +0,0 @@
-module MessagePack
-
-  #
-  # MessagePack::Packer is a class to serialize objects.
-  #
-  class Packer
-    #
-    # Creates a MessagePack::Packer instance.
-    # See Buffer#initialize for supported options.
-    #
-    # @overload initialize(options={})
-    #   @param options [Hash]
-    #
-    # @overload initialize(io, options={})
-    #   @param io [IO]
-    #   @param options [Hash]
-    #   This packer writes serialzied objects into the IO when the internal buffer is filled.
-    #   _io_ must respond to write(string) or append(string) method.
-    #
-    # Supported options:
-    #
-    # * *:compatibility_mode* serialize in older versions way, without str8 and bin types
-    #
-    # See also Buffer#initialize for other options.
-    #
-    def initialize(*args)
-    end
-
-    #
-    # Register a new ext type to serialize it. This method should be called with one of
-    # method name or block, which returns bytes(ASCII-8BIT String) representation of
-    # object to be serialized.
-    #
-    # @overload register_type(type, klass, &block)
-    #   @param type [Fixnum] type id (0-127) user defined type id for specified Class
-    #   @param klass [Class] Class to be serialized with speicifed type id
-    #   @yieldparam object [Object] object to be serialized
-    #
-    # @overload register_type(type, klass, method_name)
-    #   @param type [Fixnum] type id (0-127) user defined type id for specified Class
-    #   @param klass [Class] Class to be serialized with speicifed type id
-    #   @param method_name [Symbol] method which returns bytes of serialized representation
-    #
-    # @return nil
-    #
-    def register_type(type, klass, method_name, &block)
-    end
-
-    #
-    # Returns a list of registered types, ordered by type id.
-    # Each element is a Hash object includes keys :type, :class and :packer.
-    #
-    # @return Array
-    #
-    def registered_types
-    end
-
-    #
-    # Returns true/false which indicate specified class or type id is registered or not.
-    #
-    # @param klass_or_type [Class or Fixnum] Class or type id (0-127) to be checked
-    # @return true or false
-    #
-    def type_registered?(klass_or_type)
-    end
-
-    #
-    # Internal buffer
-    #
-    # @return MessagePack::Buffer
-    #
-    attr_reader :buffer
-
-    #
-    # Serializes an object into internal buffer, and flushes to io if necessary.
-    #
-    # If it could not serialize the object, it raises
-    # NoMethodError: undefined method `to_msgpack' for #<the_object>.
-    #
-    # @param obj [Object] object to serialize
-    # @return [Packer] self
-    #
-    def write(obj)
-    end
-
-    alias pack write
-
-    #
-    # Serializes a nil object. Same as write(nil).
-    #
-    def write_nil
-    end
-
-    #
-    # Serializes a string object as binary data. Same as write("string".encode(Encoding::BINARY)).
-    #
-    def write_bin(obj)
-    end
-
-    #
-    # Write a header of an array whose size is _n_.
-    # For example, write_array_header(1).write(true) is same as write([ true ]).
-    #
-    # @return [Packer] self
-    #
-    def write_array_header(n)
-    end
-
-    #
-    # Write a header of an map whose size is _n_.
-    # For example, write_map_header(1).write('key').write(true) is same as write('key'=>true).
-    #
-    # @return [Packer] self
-    #
-    def write_map_header(n)
-    end
-
-    #
-    # Write a header of a binary string whose size is _n_. Useful if you want to append large binary data without loading it into memory at once.
-    # For example,
-    # MessagePack::Packer.new(io).write_bin_header(12).flush
-    # io.write('chunk1')
-    # io.write('chunk2')
-    # is the same as
-    # write('chunk1chunk2'.encode(Encoding::BINARY)).
-    #
-    # @return [Packer] self
-    #
-    def write_bin_header(n)
-    end
-
-    #
-    # Serializes _value_ as 32-bit single precision float into internal buffer.
-    # _value_ will be approximated with the nearest possible single precision float, thus
-    # being potentially lossy. However, the serialized string will only take up 5 bytes
-    # instead of 9 bytes compared to directly serializing a 64-bit double precision Ruby Float.
-    #
-    # @param value [Numeric]
-    # @return [Packer] self
-    #
-    def write_float32(value)
-    end
-
-    #
-    # Flushes data in the internal buffer to the internal IO. Same as _buffer.flush.
-    # If internal IO is not set, it does nothing.
-    #
-    # @return [Packer] self
-    #
-    def flush
-    end
-
-    #
-    # Makes the internal buffer empty. Same as _buffer.clear_.
-    #
-    # @return nil
-    #
-    def clear
-    end
-
-    #
-    # Returns size of the internal buffer. Same as buffer.size.
-    #
-    # @return [Integer]
-    #
-    def size
-    end
-
-    #
-    # Returns _true_ if the internal buffer is empty. Same as buffer.empty?.
-    # This method is slightly faster than _size_.
-    #
-    # @return [Boolean]
-    #
-    def empty?
-    end
-
-    #
-    # Returns all data in the buffer as a string. Same as buffer.to_str.
-    #
-    # @return [String]
-    #
-    def to_str
-    end
-
-    alias to_s to_str
-
-    #
-    # Returns content of the internal buffer as an array of strings. Same as buffer.to_a.
-    # This method is faster than _to_str_.
-    #
-    # @return [Array] array of strings
-    #
-    def to_a
-    end
-
-    #
-    # Writes all of data in the internal buffer into the given IO. Same as buffer.write_to(io).
-    # This method consumes and removes data from the internal buffer.
-    # _io_ must respond to write(data) method.
-    #
-    # @param io [IO]
-    # @return [Integer] byte size of written data
-    #
-    def write_to(io)
-    end
-  end
-end

data/doclib/msgpack/time.rb

@@ -1,22 +0,0 @@
-module MessagePack
-
-  # MessagePack::Time provides packer and unpacker functions for a timestamp type.
-  # @example Setup for DefaultFactory
-  #   MessagePack::DefaultFactory.register_type(
-  #     MessagePack::Timestamp::TYPE,
-  #     Time,
-  #     packer: MessagePack::Time::Packer,
-  #     unpacker: MessagePack::Time::Unpacker
-  #   )
-  class Time
-    # A packer function that packs a Time instance to a MessagePack timestamp.
-    Packer = lambda { |payload|
-      # ...
-    }
-
-    # An unpacker function that unpacks a MessagePack timestamp to a Time instance.
-    Unpacker = lambda { |time|
-      # ...
-    }
-  end
-end

data/doclib/msgpack/timestamp.rb

@@ -1,44 +0,0 @@
-module MessagePack
-  # A utility class for MessagePack timestamp type
-  class Timestamp
-    #
-    # The timestamp extension type defined in the MessagePack spec.
-    #
-    # See https://github.com/msgpack/msgpack/blob/master/spec.md#timestamp-extension-type for details.
-    #
-    TYPE = -1
-
-    # @return [Integer] Second part of the timestamp.
-    attr_reader :sec
-
-    # @return [Integer] Nanosecond part of the timestamp.
-    attr_reader :nsec
-
-    # @param [Integer] sec
-    # @param [Integer] nsec
-    def initialize(sec, nsec)
-    end
-
-    # @example An unpacker implementation for the Time class
-    #   lambda do |payload|
-    #     tv = MessagePack::Timestamp.from_msgpack_ext(payload)
-    #     Time.at(tv.sec, tv.nsec, :nanosecond)
-    #   end
-    #
-    # @param [String] data
-    # @return [MessagePack::Timestamp]
-    def self.from_msgpack_ext(data)
-    end
-
-    # @example A packer implementation for the Time class
-    #   unpacker = lambda do |time|
-    #     MessagePack::Timestamp.to_msgpack_ext(time.tv_sec, time.tv_nsec)
-    #   end
-    #
-    # @param [Integer] sec
-    # @param [Integer] nsec
-    # @return [String]
-    def self.to_msgpack_ext(sec, nsec)
-    end
-  end
-end

data/doclib/msgpack/unpacker.rb

@@ -1,183 +0,0 @@
-module MessagePack
-
-  #
-  # MessagePack::Unpacker is a class to deserialize objects.
-  #
-  class Unpacker
-    #
-    # Creates a MessagePack::Unpacker instance.
-    #
-    # @overload initialize(options={})
-    #   @param options [Hash]
-    #
-    # @overload initialize(io, options={})
-    #   @param io [IO]
-    #   @param options [Hash]
-    #   This unpacker reads data from the _io_ to fill the internal buffer.
-    #   _io_ must respond to readpartial(length [,string]) or read(length [,string]) method.
-    #
-    # Supported options:
-    #
-    # * *:symbolize_keys* deserialize keys of Hash objects as Symbol instead of String
-    # * *:allow_unknown_ext* allow to deserialize ext type object with unknown type id as ExtensionValue instance. Otherwise (by default), unpacker throws UnknownExtTypeError.
-    #
-    # See also Buffer#initialize for other options.
-    #
-    def initialize(*args)
-    end
-
-    #
-    # Register a new ext type to deserialize it. This method should be called with
-    # Class and its class method name, or block, which returns a instance object.
-    #
-    # @overload register_type(type, &block)
-    #   @param type [Fixnum] type id (0-127) user defined type id for specified deserializer block
-    #   @yieldparam data [String] bytes(ASCII-8BIT String) represents serialized object, to be deserialized
-    #
-    # @overload register_type(type, klass, class_method_name)
-    #   @param type [Fixnum] type id (0-127) user defined type id for specified Class
-    #   @param klass [Class] Class to be serialized with speicifed type id
-    #   @param class_method_name [Symbol] class method which returns an instance object
-    #
-    # @return nil
-    #
-    def register_type(type, klass, method_name, &block)
-    end
-
-    #
-    # Returns a list of registered types, ordered by type id.
-    # Each element is a Hash object includes keys :type, :class and :unpacker.
-    #
-    # @return Array
-    #
-    def registered_types
-    end
-
-    #
-    # Returns true/false which indicate specified class or type id is registered or not.
-    #
-    # @param klass_or_type [Class or Fixnum] Class or type id (0-127) to be checked
-    # @return true or false
-    #
-    def type_registered?(klass_or_type)
-    end
-
-    #
-    # Internal buffer
-    #
-    # @return [MessagePack::Buffer]
-    #
-    attr_reader :buffer
-
-    #
-    # Deserializes an object from the io or internal buffer and returns it.
-    #
-    # This method reads data from io into the internal buffer and deserializes an object
-    # from the buffer. It repeats reading data from the io until enough data is available
-    # to deserialize at least one object. After deserializing one object, unused data is
-    # left in the internal buffer.
-    #
-    # If there're not enough data to deserialize one object, this method raises EOFError.
-    # If data format is invalid, this method raises MessagePack::MalformedFormatError.
-    # If the object nests too deeply, this method raises MessagePack::StackError.
-    #
-    # @return [Object] deserialized object
-    #
-    def read
-    end
-
-    alias unpack read
-
-    #
-    # Deserializes an object and ignores it. This method is faster than _read_.
-    #
-    # This method could raise the same errors with _read_.
-    #
-    # @return nil
-    #
-    def skip
-    end
-
-    #
-    # Deserializes a nil value if it exists and returns _true_.
-    # Otherwise, if a byte exists but the byte doesn't represent nil value,
-    # returns _false_.
-    #
-    # If there're not enough data, this method raises EOFError.
-    #
-    # @return [Boolean]
-    #
-    def skip_nil
-    end
-
-    #
-    # Read a header of an array and returns its size.
-    # It converts a serialized array into a stream of elements.
-    #
-    # If the serialized object is not an array, it raises MessagePack::UnexpectedTypeError.
-    # If there're not enough data, this method raises EOFError.
-    #
-    # @return [Integer] size of the array
-    #
-    def read_array_header
-    end
-
-    #
-    # Reads a header of an map and returns its size.
-    # It converts a serialized map into a stream of key-value pairs.
-    #
-    # If the serialized object is not a map, it raises MessagePack::UnexpectedTypeError.
-    # If there're not enough data, this method raises EOFError.
-    #
-    # @return [Integer] size of the map
-    #
-    def read_map_header
-    end
-
-    #
-    # Appends data into the internal buffer.
-    # This method is equivalent to unpacker.buffer.append(data).
-    #
-    # @param data [String]
-    # @return [Unpacker] self
-    #
-    def feed(data)
-    end
-
-    #
-    # Repeats to deserialize objects.
-    #
-    # It repeats until the io or internal buffer does not include any complete objects.
-    #
-    # If the an IO is set, it repeats to read data from the IO when the buffer
-    # becomes empty until the IO raises EOFError.
-    #
-    # This method could raise same errors with _read_ excepting EOFError.
-    #
-    # @yieldparam object [Object] deserialized object
-    # @return nil
-    #
-    def each(&block)
-    end
-
-    #
-    # Appends data into the internal buffer and repeats to deserialize objects.
-    # This method is equivalent to unpacker.feed(data) && unpacker.each { ... }.
-    #
-    # @param data [String]
-    # @yieldparam object [Object] deserialized object
-    # @return nil
-    #
-    def feed_each(data, &block)
-    end
-
-    #
-    # Clears the internal buffer and resets deserialization state of the unpacker.
-    #
-    # @return nil
-    #
-    def reset
-    end
-  end
-
-end