gitlab-cbor 1.0.0

data/doclib/cbor/buffer.rb

@@ -0,0 +1,193 @@
+module CBOR
+
+  class Buffer
+    #
+    # Creates a CBOR::Buffer instance.
+    #
+    # @overload initialize(options={})
+    #   @param options [Hash]
+    #
+    # @overload initialize(io, options={})
+    #   @param io [IO]
+    #   @param options [Hash]
+    #   This buffer writes written data into the IO when it is filled.
+    #   This buffer reads data from the IO when it is empty.
+    #
+    # _io_ must respond to readpartial(length, [,string]) or read(string) method and
+    # write(string) or append(string) method.
+    #
+    # Supported options:
+    #
+    # * *:io_buffer_size* buffer size to read data from the internal IO. (default: 32768)
+    # * *:read_reference_threshold* the threshold size to enable zero-copy deserialize optimization. Read strings longer than this threshold will refer the original string instead of copying it. (default: 256) (supported in MRI only)
+    # * *:write_reference_threshold* the threshold size to enable zero-copy serialize optimization. The buffer refers written strings longer than this threshold instead of copying it. (default: 524288) (supported in MRI only)
+    #
+    def initialize(*args)
+    end
+
+    #
+    # Makes the buffer empty
+    #
+    # @return nil
+    #
+    def clear
+    end
+
+    #
+    # Returns byte size of the buffer.
+    #
+    # @return nil
+    #
+    def size
+    end
+
+    #
+    # Returns _true_ if the buffer is empty.
+    # This method is slightly faster than _size_.
+    #
+    # @return [Boolean]
+    #
+    def empty?
+    end
+
+    #
+    # Appends the given data to the buffer.
+    #
+    # @param data [String]
+    # @return [Integer] byte size written
+    #
+    def write(data)
+    end
+
+    #
+    # Appends the given data to the buffer.
+    #
+    # @param data [String]
+    # @return [Buffer] self
+    #
+    def <<(data)
+    end
+
+    #
+    # Consumes _n_ bytes from the head of the buffer and returns consumed data.
+    # If the size of the buffer is less than _n_, it reads all of data in the buffer.
+    #
+    # If _n_ is 0, it does nothing and returns an empty string.
+    # If the optional _buffer_ argument is given, the content of the string will be replaced with the consumed data.
+    #
+    # @overload read
+    #
+    # @overload read(n)
+    #   @param n [Integer] bytes to read
+    #
+    # @overload read(n, buffer)
+    #   @param n [Integer] bytes to read
+    #   @param buffer [String] buffer to read into
+    #
+    # @return [String]
+    #
+    def read(n)
+    end
+
+    #
+    # Consumes _n_ bytes from the head of the buffer and returns consumed data.
+    # If the size of the buffer is less than _n_, it does nothing and raises EOFError.
+    #
+    # If _n_ is 0, it does nothing and returns an empty string.
+    # If the optional _buffer_ argument is given, the content of the string will be replaced with the consumed data.
+    #
+    # @overload read_all
+    #
+    # @overload read_all(n)
+    #   @param n [Integer] bytes to read
+    #
+    # @overload read_all(n, buffer)
+    #   @param n [Integer] bytes to read
+    #   @param buffer [String] buffer to read into
+    #
+    # @return [String]
+    #
+    def read_all(n, buffer=nil)
+    end
+
+    #
+    # Consumes _n_ bytes from the head of the buffer.
+    # If the size of the buffer is less than _n_, it skips all of data in the buffer and returns integer less than _n_.
+    #
+    # If _n_ is 0, it does nothing and returns _0_.
+    #
+    # @param n [Integer] byte size to skip
+    # @return [Integer] byte size actually skipped
+    #
+    def skip(n)
+    end
+
+    #
+    # Consumes _n_ bytes from the head of the buffer.
+    # If the size of the buffer is less than _n_, it does nothing and raises EOFError.
+    # If _n_ is 0, it does nothing.
+    #
+    # @param n [Integer] byte size to skip
+    # @return [Buffer] self
+    #
+    def skip_all(n)
+    end
+
+    #
+    # Returns all data in the buffer as a string.
+    # Destructive update to the returned string does NOT effect the buffer.
+    #
+    # @return [String]
+    #
+    def to_str
+    end
+
+    #
+    # Returns content of the buffer as an array of strings.
+    #
+    # This method is sometimes faster than to_s because the internal
+    # structure of the buffer is a queue of buffer chunks.
+    #
+    # @return [Array] array of strings
+    #
+    def to_a
+    end
+
+    #
+    # Internal io
+    #
+    # @return IO
+    #
+    attr_reader :io
+
+    #
+    # Flushes data in the internal buffer to the internal IO.
+    # If internal IO is not set, it does nothing.
+    #
+    # @return [Buffer] self
+    #
+    def flush
+    end
+
+    #
+    # Closes internal IO if its set.
+    # If internal IO is not set, it does nothing
+    #
+    # @return nil
+    #
+    def close
+    end
+
+    #
+    # Writes all of data in the internal buffer into the given 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/cbor/core_ext.rb

@@ -0,0 +1,133 @@
+
+class NilClass
+  #
+  # Same as CBOR.encode(self[, io]).
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end
+
+class TrueClass
+  #
+  # Same as CBOR.encode(self[, io]).
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end
+
+class FalseClass
+  #
+  # Same as CBOR.encode(self[, io]).
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end
+
+class Fixnum < Integer
+  #
+  # Same as CBOR.encode(self[, io]).
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end
+
+class Bignum < Integer
+  #
+  # Same as CBOR.encode(self[, io]).
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end
+
+class Float < Numeric
+  #
+  # Same as CBOR.encode(self[, io]).
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end
+
+class String
+  #
+  # Same as CBOR.encode(self[, io]).
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end
+
+class Array
+  #
+  # Same as CBOR.encode(self[, io]).
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end
+
+class Hash
+  #
+  # Same as CBOR.encode(self[, io]).
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end
+
+class Time
+  #
+  # Same as CBOR.encode(self[, io]).
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end
+
+
+class Regexp
+  #
+  # Same as CBOR.encode(self[, io]).
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end
+
+class URI
+  #
+  # Same as CBOR.encode(self[, io]).  This method is only defined if
+  # the class URI was defined when the CBOR extension was loaded, so
+  # +require "uri"+ before +require "cbor"+ if you need this.
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end
+
+class Symbol
+  #
+  # Same as CBOR.encode(self[, io]).
+  #
+  # @return [String] serialized data
+  #
+  def to_cbor(io=nil)
+  end
+end

data/doclib/cbor/error.rb

@@ -0,0 +1,14 @@
+module CBOR
+
+  class UnpackError < StandardError
+  end
+
+  class MalformedFormatError < UnpackError
+  end
+
+  class StackError < UnpackError
+  end
+
+  class TypeError < StandardError
+  end
+end

data/doclib/cbor/packer.rb

@@ -0,0 +1,133 @@
+module CBOR
+
+  #
+  # CBOR::Packer is an interface to serialize objects into an internal buffer,
+  # which is a CBOR::Buffer.
+  #
+  class Packer
+    #
+    # Creates a CBOR::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.
+    #
+    def initialize(*args)
+    end
+
+    #
+    # Internal buffer
+    #
+    # @return CBOR::Buffer
+    #
+    attr_reader :buffer
+
+    #
+    # Serializes an object into internal buffer.
+    #
+    # If it could not serialize the object, it raises
+    # NoMethodError: undefined method `to_cbor' 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
+
+    #
+    # 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
+
+    #
+    # 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/cbor/simple.rb

@@ -0,0 +1,15 @@
+module CBOR
+
+  #
+  # CBOR::Simple is used to carry around simple values that don't map
+  # into Ruby classes (false, true, nil are the ones that do).
+  class Simple
+
+    # @param value [Integer] The integer number of the simple value
+    def initialize(value)
+    end
+
+    attr_reader :value
+
+  end
+end

data/doclib/cbor/tagged.rb

@@ -0,0 +1,16 @@
+module CBOR
+
+  #
+  # CBOR::Tagged is used to carry around tagged values that don't map
+  # into Ruby classes (false, true, nil are the ones that do).
+  class Tagged
+
+    # @param tag [Integer] The integer number of the tag
+    # @param value [Object] The value that is being tagged
+    def initialize(tag, value)
+    end
+
+    attr_reader :tag, :value
+
+  end
+end

data/doclib/cbor/unpacker.rb

@@ -0,0 +1,138 @@
+module CBOR
+
+  #
+  # CBOR::Unpacker is an interface to deserialize objects from an internal buffer,
+  # which is a CBOR::Buffer.
+  #
+  class Unpacker
+    #
+    # Creates a CBOR::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.
+    #
+    # See Buffer#initialize for supported options.
+    #
+    def initialize(*args)
+    end
+
+    #
+    # Internal buffer
+    #
+    # @return [CBOR::Buffer]
+    #
+    attr_reader :buffer
+
+    #
+    # Deserializes an object from internal buffer and returns it.
+    #
+    # If there're not enough buffer, this method raises EOFError.
+    # If data format is invalid, this method raises CBOR::MalformedFormatError.
+    # If the stack is too deep, this method raises CBOR::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 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 buffer, 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 CBOR::TypeError.
+    # If there're not enough buffer, 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 CBOR::TypeError.
+    # If there're not enough buffer, this method raises EOFError.
+    #
+    # @return [Integer] size of the map
+    #
+    def read_map_header
+    end
+
+    #
+    # Appends data into the internal buffer.
+    # This method calls buffer.append(data).
+    #
+    # @param data [String]
+    # @return [Unpacker] self
+    #
+    def feed(data)
+    end
+
+    #
+    # Repeats to deserialize objects.
+    #
+    # It repeats until the 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 equals to feed(data) && each.
+    #
+    # @param data [String]
+    # @yieldparam object [Object] deserialized object
+    # @return nil
+    #
+    def feed_each(data, &block)
+    end
+
+    #
+    # Resets deserialization state of the unpacker and clears the internal buffer.
+    #
+    # @return nil
+    #
+    def reset
+    end
+  end
+
+end

data/doclib/cbor.rb

@@ -0,0 +1,80 @@
+module CBOR
+  #
+  # Serializes an object into an IO or String.
+  #
+  # @overload encode(obj)
+  #   @return [String] serialized data
+  #
+  # @overload encode(obj, io)
+  #   @return [IO]
+  #
+  def self.encode(arg)
+  end
+
+  #
+  # Serializes an object into an IO or String. Alias of encode.
+  #
+  # @overload dump(obj)
+  #   @return [String] serialized data
+  #
+  # @overload dump(obj, io)
+  #   @return [IO]
+  #
+  def self.dump(arg)
+  end
+
+  #
+  # Serializes an object into an IO or String. Alias of encode.
+  #
+  # @overload dump(obj)
+  #   @return [String] serialized data
+  #
+  # @overload dump(obj, io)
+  #   @return [IO]
+  #
+  def self.pack(arg)
+  end
+
+  #
+  # Deserializes an object from an IO or String.
+  #
+  # @overload decode(string)
+  #   @param string [String] data to deserialize
+  #
+  # @overload decode(io)
+  #   @param io [IO]
+  #
+  # @return [Object] deserialized object
+  #
+  def self.decode(arg)
+  end
+
+  #
+  # Deserializes an object from an IO or String. Alias of decode.
+  #
+  # @overload load(string)
+  #   @param string [String] data to deserialize
+  #
+  # @overload load(io)
+  #   @param io [IO]
+  #
+  # @return [Object] deserialized object
+  #
+  def self.load(arg)
+  end
+
+  #
+  # Deserializes an object from an IO or String. Alias of decode.
+  #
+  # @overload unpack(string)
+  #   @param string [String] data to deserialize
+  #
+  # @overload unpack(io)
+  #   @param io [IO]
+  #
+  # @return [Object] deserialized object
+  #
+  def self.unpack(arg)
+  end
+end
+