From 5a435c4bde236b8db7f450d5046813d5fab8fb20 Mon Sep 17 00:00:00 2001 From: FURUHASHI Sadayuki Date: Thu, 20 Dec 2012 11:14:37 -0800 Subject: [PATCH 01/11] added Rakefile --- .gitignore | 7 +++++++ Gemfile | 7 +++++++ Rakefile | 23 +++++++++++++++++++++++ 3 files changed, 37 insertions(+) create mode 100644 .gitignore create mode 100644 Gemfile create mode 100644 Rakefile diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..0b17f8b8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +Gemfile* +.bundle +.rbenv-version +.DS_Store +*~ +/msgpack-ruby +/vendor diff --git a/Gemfile b/Gemfile new file mode 100644 index 00000000..463a3583 --- /dev/null +++ b/Gemfile @@ -0,0 +1,7 @@ +source :rubygems + +gem 'rake', '~> 0.9.2' +gem 'rake-compiler', '~> 0.8.1' +gem 'rspec', '~> 2.11' +gem 'yard', '~> 0.8.2' + diff --git a/Rakefile b/Rakefile new file mode 100644 index 00000000..815897d3 --- /dev/null +++ b/Rakefile @@ -0,0 +1,23 @@ +require 'fileutils' + +task :update do + if File.directory?("msgpack-ruby") + Dir.glob("msgpack-ruby/*", &FileUtils.method(:rm_rf)) + Dir.chdir("msgpack-ruby") do + sh "git checkout ." + end + else + sh "git clone git://github.com/msgpack/msgpack-ruby.git" + end + + Dir.chdir("msgpack-ruby") do + sh "git checkout master" + sh "git pull" + sh "rake doc" + end + + FileUtils.cp_r Dir.glob("msgpack-ruby/doc/*"), '.' +end + +task :default => :update + From 29cea187a98ce357f760ea29144ea21102b9f0db Mon Sep 17 00:00:00 2001 From: FURUHASHI Sadayuki Date: Thu, 20 Dec 2012 11:15:30 -0800 Subject: [PATCH 02/11] added html files --- Array.html | 218 +++ Bignum.html | 221 +++ FalseClass.html | 218 +++ Fixnum.html | 221 +++ Float.html | 221 +++ Hash.html | 218 +++ MessagePack.html | 726 ++++++++++ MessagePack/Buffer.html | 1830 +++++++++++++++++++++++++ MessagePack/MalformedFormatError.html | 131 ++ MessagePack/Packer.html | 1313 ++++++++++++++++++ MessagePack/StackError.html | 131 ++ MessagePack/TypeError.html | 123 ++ MessagePack/UnpackError.html | 127 ++ MessagePack/Unpacker.html | 1146 ++++++++++++++++ NilClass.html | 218 +++ String.html | 218 +++ Symbol.html | 218 +++ TrueClass.html | 218 +++ _index.html | 284 ++++ class_list.html | 53 + css/common.css | 1 + css/full_list.css | 57 + css/style.css | 328 +++++ file.README.html | 199 +++ file_list.html | 55 + frames.html | 28 + index.html | 199 +++ js/app.js | 214 +++ js/full_list.js | 173 +++ js/jquery.js | 4 + method_list.html | 476 +++++++ top-level-namespace.html | 114 ++ 32 files changed, 9901 insertions(+) create mode 100644 Array.html create mode 100644 Bignum.html create mode 100644 FalseClass.html create mode 100644 Fixnum.html create mode 100644 Float.html create mode 100644 Hash.html create mode 100644 MessagePack.html create mode 100644 MessagePack/Buffer.html create mode 100644 MessagePack/MalformedFormatError.html create mode 100644 MessagePack/Packer.html create mode 100644 MessagePack/StackError.html create mode 100644 MessagePack/TypeError.html create mode 100644 MessagePack/UnpackError.html create mode 100644 MessagePack/Unpacker.html create mode 100644 NilClass.html create mode 100644 String.html create mode 100644 Symbol.html create mode 100644 TrueClass.html create mode 100644 _index.html create mode 100644 class_list.html create mode 100644 css/common.css create mode 100644 css/full_list.css create mode 100644 css/style.css create mode 100644 file.README.html create mode 100644 file_list.html create mode 100644 frames.html create mode 100644 index.html create mode 100644 js/app.js create mode 100644 js/full_list.js create mode 100644 js/jquery.js create mode 100644 method_list.html create mode 100644 top-level-namespace.html diff --git a/Array.html b/Array.html new file mode 100644 index 00000000..c8337dad --- /dev/null +++ b/Array.html @@ -0,0 +1,218 @@ + + + + + + Class: Array + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: Array + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/core_ext.rb
+ +
+
+ + + + + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + + + +
+

Instance Method Details

+ + +
+

+ + - (String) to_msgpack(io = nil) + + + + + +

+
+ +

Same as MessagePack.to_msgpack(self[, io]).

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    serialized data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+78
+79
+ 		+ 
# File 'doclib/msgpack/core_ext.rb', line 78
+
+def to_msgpack(io=nil)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/Bignum.html b/Bignum.html new file mode 100644 index 00000000..42fe82c5 --- /dev/null +++ b/Bignum.html @@ -0,0 +1,221 @@ + + + + + + Class: Bignum + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: Bignum + + + +

+ +
+ +
Inherits:
+
+ Integer + +
    +
  • Object
    • + + + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/core_ext.rb
+ +
+
+ + + + + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + + + + +
+

Instance Method Details

+ + +
+

+ + - (String) to_msgpack(io = nil) + + + + + +

+
+ +

Same as MessagePack.to_msgpack(self[, io]).

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    serialized data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+48
+49
+ 		+ 
# File 'doclib/msgpack/core_ext.rb', line 48
+
+def to_msgpack(io=nil)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/FalseClass.html b/FalseClass.html new file mode 100644 index 00000000..37677d22 --- /dev/null +++ b/FalseClass.html @@ -0,0 +1,218 @@ + + + + + + Class: FalseClass + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: FalseClass + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/core_ext.rb
+ +
+
+ + + + + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + + + +
+

Instance Method Details

+ + +
+

+ + - (String) to_msgpack(io = nil) + + + + + +

+
+ +

Same as MessagePack.to_msgpack(self[, io]).

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    serialized data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+28
+29
+ 		+ 
# File 'doclib/msgpack/core_ext.rb', line 28
+
+def to_msgpack(io=nil)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/Fixnum.html b/Fixnum.html new file mode 100644 index 00000000..6e3a1119 --- /dev/null +++ b/Fixnum.html @@ -0,0 +1,221 @@ + + + + + + Class: Fixnum + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: Fixnum + + + +

+ +
+ +
Inherits:
+
+ Integer + +
    +
  • Object
    • + + + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/core_ext.rb
+ +
+
+ + + + + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + + + + +
+

Instance Method Details

+ + +
+

+ + - (String) to_msgpack(io = nil) + + + + + +

+
+ +

Same as MessagePack.to_msgpack(self[, io]).

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    serialized data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+38
+39
+ 		+ 
# File 'doclib/msgpack/core_ext.rb', line 38
+
+def to_msgpack(io=nil)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/Float.html b/Float.html new file mode 100644 index 00000000..d3cce9f7 --- /dev/null +++ b/Float.html @@ -0,0 +1,221 @@ + + + + + + Class: Float + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: Float + + + +

+ +
+ +
Inherits:
+
+ Numeric + +
    +
  • Object
    • + + + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/core_ext.rb
+ +
+
+ + + + + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + + + + +
+

Instance Method Details

+ + +
+

+ + - (String) to_msgpack(io = nil) + + + + + +

+
+ +

Same as MessagePack.to_msgpack(self[, io]).

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    serialized data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+58
+59
+ 		+ 
# File 'doclib/msgpack/core_ext.rb', line 58
+
+def to_msgpack(io=nil)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/Hash.html b/Hash.html new file mode 100644 index 00000000..6d428c92 --- /dev/null +++ b/Hash.html @@ -0,0 +1,218 @@ + + + + + + Class: Hash + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: Hash + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/core_ext.rb
+ +
+
+ + + + + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + + + +
+

Instance Method Details

+ + +
+

+ + - (String) to_msgpack(io = nil) + + + + + +

+
+ +

Same as MessagePack.to_msgpack(self[, io]).

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    serialized data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+88
+89
+ 		+ 
# File 'doclib/msgpack/core_ext.rb', line 88
+
+def to_msgpack(io=nil)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/MessagePack.html b/MessagePack.html new file mode 100644 index 00000000..ff345d38 --- /dev/null +++ b/MessagePack.html @@ -0,0 +1,726 @@ + + + + + + Module: MessagePack + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Module: MessagePack + + + +

+ +
+ + + + + + + + +
Defined in:
+
lib/msgpack/version.rb,
+ doclib/msgpack.rb,
doclib/msgpack/error.rb,
doclib/msgpack/packer.rb,
doclib/msgpack/buffer.rb,
doclib/msgpack/unpacker.rb +
+ +
+
+ +

Defined Under Namespace

+

+ + + + + Classes: Buffer, MalformedFormatError, Packer, StackError, TypeError, UnpackError, Unpacker + + +

+ +

Constant Summary

+ +
+ +
VERSION = + +
+ 
"0.5.0"
+ +
+ + + + + + + + + +

+ Class Method Summary + (collapse) +

+ +
    + +
  • + + + + (Object) dump(arg) + + + + + + + + + + + + + +
    +

    Serializes an object into an IO or String.

    +
     + +
    • + + +
  • + + + + (Object) load(arg) + + + + + + + + + + + + + +
    +

    Deserializes an object from an IO or String.

    +
     + +
    • + + +
  • + + + + (Object) pack(arg) + + + + + + + + + + + + + +
    +

    Serializes an object into an IO or String.

    +
     + +
    • + + +
  • + + + + (Object) unpack(arg) + + + + + + + + + + + + + +
    +

    Deserializes an object from an IO or String.

    +
     + +
    • + + +
+ + + + +
+

Class Method Details

+ + +
+

+ + + + (String) dump(obj) + + + (IO) dump(obj, io) + + + + + + +

+
+ +

Serializes an object into an IO or String.

+ + +
+
+
+ +

Overloads:

+
    + + +
  • + + (String) dump(obj) +
    +
    + +

    Serialized data

    + + +
    +
    +
    + +

    Returns:

    +
      + +
    • + + + (String) + + + + — +
      +

      serialized data

      +
      + +
      • + +
    + +
    +
    • + + +
  • + + (IO) dump(obj, io) +
    +
    + + +
    +
    +
    + +

    Returns:

    +
      + +
    • + + + (IO) + + + +
      • + +
    + +
    +
    • + +
+ + +
+ + + + +
+ 
+
+
+12
+13
+ 		+ 
# File 'doclib/msgpack.rb', line 12
+
+def self.dump(arg)
+end
+
+
+ +
+

+ + + + (Object) load(string) + + + (Object) load(io) + + + + + + +

+
+ +

Deserializes an object from an IO or String.

+ + +
+
+
+ +

Overloads:

+
    + + +
  • + + (Object) load(string) +
    +
    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + string + + + (String) + + + + — +
      +

      data to deserialize

      +
      + +
      • + +
    + + +
    +
    • + + +
  • + + (Object) load(io) +
    +
    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + io + + + (IO) + + + +
      • + +
    + + +
    +
    • + +
+ +

Returns:

+
    + +
  • + + + (Object) + + + + — +
    +

    deserialized object

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+38
+39
+ 		+ 
# File 'doclib/msgpack.rb', line 38
+
+def self.load(arg)
+end
+
+
+ +
+

+ + + + (String) dump(obj) + + + (IO) dump(obj, io) + + + + + + +

+
+ +

Serializes an object into an IO or String. Alias of dump.

+ + +
+
+
+ +

Overloads:

+
    + + +
  • + + (String) dump(obj) +
    +
    + +

    Serialized data

    + + +
    +
    +
    + +

    Returns:

    +
      + +
    • + + + (String) + + + + — +
      +

      serialized data

      +
      + +
      • + +
    + +
    +
    • + + +
  • + + (IO) dump(obj, io) +
    +
    + + +
    +
    +
    + +

    Returns:

    +
      + +
    • + + + (IO) + + + +
      • + +
    + +
    +
    • + +
+ + +
+ + + + +
+ 
+
+
+24
+25
+ 		+ 
# File 'doclib/msgpack.rb', line 24
+
+def self.pack(arg)
+end
+
+
+ +
+

+ + + + (Object) unpack(string) + + + (Object) unpack(io) + + + + + + +

+
+ +

Deserializes an object from an IO or String. Alias of load.

+ + +
+
+
+ +

Overloads:

+
    + + +
  • + + (Object) unpack(string) +
    +
    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + string + + + (String) + + + + — +
      +

      data to deserialize

      +
      + +
      • + +
    + + +
    +
    • + + +
  • + + (Object) unpack(io) +
    +
    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + io + + + (IO) + + + +
      • + +
    + + +
    +
    • + +
+ +

Returns:

+
    + +
  • + + + (Object) + + + + — +
    +

    deserialized object

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+52
+53
+ 		+ 
# File 'doclib/msgpack.rb', line 52
+
+def self.unpack(arg)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/MessagePack/Buffer.html b/MessagePack/Buffer.html new file mode 100644 index 00000000..cb4b20f2 --- /dev/null +++ b/MessagePack/Buffer.html @@ -0,0 +1,1830 @@ + + + + + + Class: MessagePack::Buffer + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: MessagePack::Buffer + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/buffer.rb
+ +
+
+ + + + + +

Instance Attribute Summary (collapse)

+
    + +
  • + + + - (Object) io + + + + + + + + + readonly + + + + + + + + + +
    +

    Internal io.

    +
     + +
    • + + +
+ + + + + +

+ Instance Method Summary + (collapse) +

+ +
    + +
  • + + + - (Buffer) <<(data) + + + + + + + + + + + + + +
    +

    Appends the given data to the buffer.

    +
     + +
    • + + +
  • + + + - (Object) clear + + + + + + + + + + + + + +
    +

    Makes the buffer empty.

    +
     + +
    • + + +
  • + + + - (Object) close + + + + + + + + + + + + + +
    +

    Closes internal IO if its set.

    +
     + +
    • + + +
  • + + + - (Boolean) empty? + + + + + + + + + + + + + +
    +

    Returns true if the buffer is empty.

    +
     + +
    • + + +
  • + + + - (Buffer) flush + + + + + + + + + + + + + +
    +

    Flushes data in the internal buffer to the internal IO.

    +
     + +
    • + + +
  • + + + - (Buffer) initialize(*args) + + + + + + + constructor + + + + + + + + +
    +

    Creates a MessagePack::Buffer instance.

    +
     + +
    • + + +
  • + + + - (String) read(n) + + + + + + + + + + + + + +
    +

    Consumes n bytes from the head of the buffer and returns consumed +data.

    +
     + +
    • + + +
  • + + + - (String) read_all(n, buffer = nil) + + + + + + + + + + + + + +
    +

    Consumes n bytes from the head of the buffer and returns consumed +data.

    +
     + +
    • + + +
  • + + + - (Object) size + + + + + + + + + + + + + +
    +

    Returns byte size of the buffer.

    +
     + +
    • + + +
  • + + + - (Integer) skip(n) + + + + + + + + + + + + + +
    +

    Consumes n bytes from the head of the buffer.

    +
     + +
    • + + +
  • + + + - (Buffer) skip_all(n) + + + + + + + + + + + + + +
    +

    Consumes n bytes from the head of the buffer.

    +
     + +
    • + + +
  • + + + - (Array) to_a + + + + + + + + + + + + + +
    +

    Returns content of the buffer as an array of strings.

    +
     + +
    • + + +
  • + + + - (String) to_str + + + + + + + + + + + + + +
    +

    Returns all data in the buffer as a string.

    +
     + +
    • + + +
  • + + + - (Integer) write(data) + + + + + + + + + + + + + +
    +

    Appends the given data to the buffer.

    +
     + +
    • + + +
  • + + + - (Integer) write_to(io) + + + + + + + + + + + + + +
    +

    Writes all of data in the internal buffer into the given IO.

    +
     + +
    • + + +
+ + +
+

Constructor Details

+ +
+

+ + + - (Buffer) initialize(options = {}) + + - (Buffer) initialize(io, options = {}) + + + + + + +

+
+ +

Creates a MessagePack::Buffer instance.

+ +

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)

    +
+ + +
+
+
+ +

Overloads:

+
    + + +
  • + - (Buffer) initialize(options = {}) +
    +
    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + options + + + (Hash) + + + +
      • + +
    + + +
    +
    • + + +
  • + - (Buffer) initialize(io, options = {}) +
    +
    + +

    This buffer writes written data into the IO when it is filled. This buffer +reads data from the IO when it is empty.

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + io + + + (IO) + + + +
      • + +
    • + + options + + + (Hash) + + + +
      • + +
    + + +
    +
    • + +
+ + +
+ + + + +
+ 
+
+
+25
+26
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 25
+
+def initialize(*args)
+end
+
+
+ +
+ +
+

Instance Attribute Details

+ + + +
+

+ + - (Object) io (readonly) + + + + + +

+
+ +

Internal io

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + + + + + +
    +

    IO

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+161
+162
+163
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 161
+
+def io
+  @io
+end
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

+ + - (Buffer) <<(data) + + + + + +

+
+ +

Appends the given data to the buffer.

+ + +
+
+
+

Parameters:

+
    + +
  • + + data + + + (String) + + + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Buffer) + + + + — +
    +

    self

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+68
+69
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 68
+
+def <<(data)
+end
+
+
+ +
+

+ + - (Object) clear + + + + + +

+
+ +

Makes the buffer empty

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + + + + + +
    +

    nil

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+33
+34
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 33
+
+def clear
+end
+
+
+ +
+

+ + - (Object) close + + + + + +

+
+ +

Closes internal IO if its set. If internal IO is not set, it does nothing

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + + + + + +
    +

    nil

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+178
+179
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 178
+
+def close
+end
+
+
+ +
+

+ + - (Boolean) empty? + + + + + +

+
+ +

Returns true if the buffer is empty. This method is slightly +faster than size.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+50
+51
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 50
+
+def empty?
+end
+
+
+ +
+

+ + - (Buffer) flush + + + + + +

+
+ +

Flushes data in the internal buffer to the internal IO. If internal IO is +not set, it does nothing.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Buffer) + + + + — +
    +

    self

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+169
+170
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 169
+
+def flush
+end
+
+
+ +
+

+ + + - (String) read + + - (String) read(n) + + - (String) read(n, buffer) + + + + + + +

+
+ +

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.

+ + +
+
+
+ +

Overloads:

+
    + + + +
  • + - (String) read(n) +
    +
    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + n + + + (Integer) + + + + — +
      +

      bytes to read

      +
      + +
      • + +
    + + +
    +
    • + + +
  • + - (String) read(n, buffer) +
    +
    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + n + + + (Integer) + + + + — +
      +

      bytes to read

      +
      + +
      • + +
    • + + buffer + + + (String) + + + + — +
      +

      buffer to read into

      +
      + +
      • + +
    + + +
    +
    • + +
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+89
+90
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 89
+
+def read(n)
+end
+
+
+ +
+

+ + + - (String) read_all + + - (String) read_all(n) + + - (String) read_all(n, buffer) + + + + + + +

+
+ +

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.

+ + +
+
+
+ +

Overloads:

+
    + + + +
  • + - (String) read_all(n) +
    +
    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + n + + + (Integer) + + + + — +
      +

      bytes to read

      +
      + +
      • + +
    + + +
    +
    • + + +
  • + - (String) read_all(n, buffer) +
    +
    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + n + + + (Integer) + + + + — +
      +

      bytes to read

      +
      + +
      • + +
    • + + buffer + + + (String) + + + + — +
      +

      buffer to read into

      +
      + +
      • + +
    + + +
    +
    • + +
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+110
+111
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 110
+
+def read_all(n, buffer=nil)
+end
+
+
+ +
+

+ + - (Object) size + + + + + +

+
+ +

Returns byte size of the buffer.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + + + + + +
    +

    nil

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+41
+42
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 41
+
+def size
+end
+
+
+ +
+

+ + - (Integer) skip(n) + + + + + +

+
+ +

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.

+ + +
+
+
+

Parameters:

+
    + +
  • + + n + + + (Integer) + + + + — +
    +

    byte size to skip

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    byte size actually skipped

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+122
+123
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 122
+
+def skip(n)
+end
+
+
+ +
+

+ + - (Buffer) skip_all(n) + + + + + +

+
+ +

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.

+ + +
+
+
+

Parameters:

+
    + +
  • + + n + + + (Integer) + + + + — +
    +

    byte size to skip

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Buffer) + + + + — +
    +

    self

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+133
+134
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 133
+
+def skip_all(n)
+end
+
+
+ +
+

+ + - (Array) to_a + + + + + +

+
+ +

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.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Array) + + + + — +
    +

    array of strings

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+153
+154
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 153
+
+def to_a
+end
+
+
+ +
+

+ + - (String) to_str + + + + + +

+
+ +

Returns all data in the buffer as a string. Destructive update to the +returned string does NOT effect the buffer.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+142
+143
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 142
+
+def to_str
+end
+
+
+ +
+

+ + - (Integer) write(data) + + + + + +

+
+ +

Appends the given data to the buffer.

+ + +
+
+
+

Parameters:

+
    + +
  • + + data + + + (String) + + + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    byte size written

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+59
+60
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 59
+
+def write(data)
+end
+
+
+ +
+

+ + - (Integer) write_to(io) + + + + + +

+
+ +

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.

+ + +
+
+
+

Parameters:

+
    + +
  • + + io + + + (IO) + + + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    byte size of written data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+189
+190
+ 		+ 
# File 'doclib/msgpack/buffer.rb', line 189
+
+def write_to(io)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/MessagePack/MalformedFormatError.html b/MessagePack/MalformedFormatError.html new file mode 100644 index 00000000..fc293f30 --- /dev/null +++ b/MessagePack/MalformedFormatError.html @@ -0,0 +1,131 @@ + + + + + + Exception: MessagePack::MalformedFormatError + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Exception: MessagePack::MalformedFormatError + + + +

+ +
+ +
Inherits:
+
+ UnpackError + +
    +
  • Object
    • + + + + + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/error.rb
+ +
+
+ + + + + + + + + + + + + + + + + +
+ + + + + \ No newline at end of file diff --git a/MessagePack/Packer.html b/MessagePack/Packer.html new file mode 100644 index 00000000..8eb6a21c --- /dev/null +++ b/MessagePack/Packer.html @@ -0,0 +1,1313 @@ + + + + + + Class: MessagePack::Packer + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: MessagePack::Packer + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/packer.rb
+ +
+
+ +

Overview

+
+ +

MessagePack::Packer is an interface to serialize objects into an internal +buffer, which is a MessagePack::Buffer.

+ + +
+
+
+ + +
+ + + +

Instance Attribute Summary (collapse)

+
    + +
  • + + + - (Object) buffer + + + + + + + + + readonly + + + + + + + + + +
    +

    Internal buffer.

    +
     + +
    • + + +
+ + + + + +

+ Instance Method Summary + (collapse) +

+ +
    + +
  • + + + - (Object) clear + + + + + + + + + + + + + +
    +

    Makes the internal buffer empty.

    +
     + +
    • + + +
  • + + + - (Boolean) empty? + + + + + + + + + + + + + +
    +

    Returns true if the internal buffer is empty.

    +
     + +
    • + + +
  • + + + - (Packer) flush + + + + + + + + + + + + + +
    +

    Flushes data in the internal buffer to the internal IO.

    +
     + +
    • + + +
  • + + + - (Packer) initialize(*args) + + + + + + + constructor + + + + + + + + +
    +

    Creates a MessagePack::Packer instance.

    +
     + +
    • + + +
  • + + + - (Integer) size + + + + + + + + + + + + + +
    +

    Returns size of the internal buffer.

    +
     + +
    • + + +
  • + + + - (Array) to_a + + + + + + + + + + + + + +
    +

    Returns content of the internal buffer as an array of strings.

    +
     + +
    • + + +
  • + + + - (String) to_str + + + + + + + + + + + + + +
    +

    Returns all data in the buffer as a string.

    +
     + +
    • + + +
  • + + + - (Packer) write(obj) + + + + (also: #pack) + + + + + + + + + + + +
    +

    Serializes an object into internal buffer.

    +
     + +
    • + + +
  • + + + - (Packer) write_array_header(size) + + + + + + + + + + + + + +
    +

    Write a header of an array whose size is n.

    +
     + +
    • + + +
  • + + + - (Packer) write_map_header(size) + + + + + + + + + + + + + +
    +

    Write a header of an map whose size is n.

    +
     + +
    • + + +
  • + + + - (Object) write_nil + + + + + + + + + + + + + +
    +

    Serializes a nil object.

    +
     + +
    • + + +
  • + + + - (Integer) write_to(io) + + + + + + + + + + + + + +
    +

    Writes all of data in the internal buffer into the given IO.

    +
     + +
    • + + +
+ + +
+

Constructor Details

+ +
+

+ + + - (Packer) initialize(options = {}) + + - (Packer) initialize(io, options = {}) + + + + + + +

+
+ +

Creates a MessagePack::Packer instance. See Buffer#initialize for supported +options.

+ + +
+
+
+ +

Overloads:

+
    + + +
  • + - (Packer) initialize(options = {}) +
    +
    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + options + + + (Hash) + + + +
      • + +
    + + +
    +
    • + + +
  • + - (Packer) initialize(io, options = {}) +
    +
    + +

    This packer writes serialzied objects into the IO when the internal buffer +is filled. io must respond to write(string) or append(string) +method.

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + io + + + (IO) + + + +
      • + +
    • + + options + + + (Hash) + + + +
      • + +
    + + +
    +
    • + +
+ + +
+ + + + +
+ 
+
+
+21
+22
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 21
+
+def initialize(*args)
+end
+
+
+ +
+ +
+

Instance Attribute Details

+ + + +
+

+ + - (Object) buffer (readonly) + + + + + +

+
+ +

Internal buffer

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + + + + + +
    +

    MessagePack::Unpacker

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+29
+30
+31
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 29
+
+def buffer
+  @buffer
+end
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

+ + - (Object) clear + + + + + +

+
+ +

Makes the internal buffer empty. Same as buffer.clear.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + + + + + +
    +

    nil

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+83
+84
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 83
+
+def clear
+end
+
+
+ +
+

+ + - (Boolean) empty? + + + + + +

+
+ +

Returns true if the internal buffer is empty. Same as +buffer.empty?. This method is slightly faster than size.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+100
+101
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 100
+
+def empty?
+end
+
+
+ +
+

+ + - (Packer) flush + + + + + +

+
+ +

Flushes data in the internal buffer to the internal IO. Same as +_buffer.flush. If internal IO is not set, it doesn nothing.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Packer) + + + + — +
    +

    self

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+75
+76
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 75
+
+def flush
+end
+
+
+ +
+

+ + - (Integer) size + + + + + +

+
+ +

Returns size of the internal buffer. Same as buffer.size.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+91
+92
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 91
+
+def size
+end
+
+
+ +
+

+ + - (Array) to_a + + + + + +

+
+ +

Returns content of the internal buffer as an array of strings. Same as +buffer.to_a. This method is faster than to_str.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Array) + + + + — +
    +

    array of strings

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+117
+118
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 117
+
+def to_a
+end
+
+
+ +
+

+ + - (String) to_str + + + + + +

+
+ +

Returns all data in the buffer as a string. Same as buffer.to_str.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+108
+109
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 108
+
+def to_str
+end
+
+
+ +
+

+ + - (Packer) write(obj) + + + + Also known as: + pack + + + + +

+
+ +

Serializes an object into internal buffer.

+ +

If it could not serialize the object, it raises NoMethodError: undefined +method `to_msgpack' for #<the_object>.

+ + +
+
+
+

Parameters:

+
    + +
  • + + obj + + + (Object) + + + + — +
    +

    object to serialize

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Packer) + + + + — +
    +

    self

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+40
+41
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 40
+
+def write(obj)
+end
+
+
+ +
+

+ + - (Packer) write_array_header(size) + + + + + +

+
+ +

Write a header of an array whose size is n. For example, +write_array_header(1).write(true) is same as write([ true ]).

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Packer) + + + + — +
    +

    self

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+57
+58
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 57
+
+def write_array_header(size)
+end
+
+
+ +
+

+ + - (Packer) write_map_header(size) + + + + + +

+
+ +

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).

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Packer) + + + + — +
    +

    self

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+66
+67
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 66
+
+def write_map_header(size)
+end
+
+
+ +
+

+ + - (Object) write_nil + + + + + +

+
+ +

Serializes a nil object. Same as write(nil).

+ + +
+
+
+ + +
+ + + + +
+ 
+
+
+48
+49
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 48
+
+def write_nil
+end
+
+
+ +
+

+ + - (Integer) write_to(io) + + + + + +

+
+ +

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.

+ + +
+
+
+

Parameters:

+
    + +
  • + + io + + + (IO) + + + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    byte size of written data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+128
+129
+ 		+ 
# File 'doclib/msgpack/packer.rb', line 128
+
+def write_to(io)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/MessagePack/StackError.html b/MessagePack/StackError.html new file mode 100644 index 00000000..8101a8a7 --- /dev/null +++ b/MessagePack/StackError.html @@ -0,0 +1,131 @@ + + + + + + Exception: MessagePack::StackError + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Exception: MessagePack::StackError + + + +

+ +
+ +
Inherits:
+
+ UnpackError + +
    +
  • Object
    • + + + + + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/error.rb
+ +
+
+ + + + + + + + + + + + + + + + + +
+ + + + + \ No newline at end of file diff --git a/MessagePack/TypeError.html b/MessagePack/TypeError.html new file mode 100644 index 00000000..5d322031 --- /dev/null +++ b/MessagePack/TypeError.html @@ -0,0 +1,123 @@ + + + + + + Exception: MessagePack::TypeError + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Exception: MessagePack::TypeError + + + +

+ +
+ +
Inherits:
+
+ StandardError + +
    +
  • Object
    • + + + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/error.rb
+ +
+
+ + + + + + + + + + + +
+ + + + + \ No newline at end of file diff --git a/MessagePack/UnpackError.html b/MessagePack/UnpackError.html new file mode 100644 index 00000000..feea3783 --- /dev/null +++ b/MessagePack/UnpackError.html @@ -0,0 +1,127 @@ + + + + + + Exception: MessagePack::UnpackError + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Exception: MessagePack::UnpackError + + + +

+ +
+ +
Inherits:
+
+ StandardError + +
    +
  • Object
    • + + + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/error.rb
+ +
+
+ +
+

Direct Known Subclasses

+

MalformedFormatError, StackError

+
+ + + + + + + + + + +
+ + + + + \ No newline at end of file diff --git a/MessagePack/Unpacker.html b/MessagePack/Unpacker.html new file mode 100644 index 00000000..924d1ba0 --- /dev/null +++ b/MessagePack/Unpacker.html @@ -0,0 +1,1146 @@ + + + + + + Class: MessagePack::Unpacker + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: MessagePack::Unpacker + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/unpacker.rb
+ +
+
+ +

Overview

+
+ +

MessagePack::Unpacker is an interface to deserialize objects from an +internal buffer, which is a MessagePack::Buffer.

+ + +
+
+
+ + +
+ + + +

Instance Attribute Summary (collapse)

+ + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + +
+

Constructor Details

+ +
+

+ + + - (Unpacker) initialize(options = {}) + + - (Unpacker) initialize(io, options = {}) + + + + + + +

+
+ +

Creates a MessagePack::Unpacker instance.

+ +

See Buffer#initialize for supported options.

+ + +
+
+
+ +

Overloads:

+
    + + +
  • + - (Unpacker) initialize(options = {}) +
    +
    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + options + + + (Hash) + + + +
      • + +
    + + +
    +
    • + + +
  • + - (Unpacker) initialize(io, options = {}) +
    +
    + +

    This unpacker reads data from the io to fill the internal buffer. +io must respond to readpartial(length [,string]) or read(length +[,string]) method.

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + io + + + (IO) + + + +
      • + +
    • + + options + + + (Hash) + + + +
      • + +
    + + +
    +
    • + +
+ + +
+ + + + +
+ 
+
+
+22
+23
+ 		+ 
# File 'doclib/msgpack/unpacker.rb', line 22
+
+def initialize(*args)
+end
+
+
+ +
+ +
+

Instance Attribute Details

+ + + +
+

+ + - (MessagePack::Unpacker) buffer (readonly) + + + + + +

+
+ +

Internal buffer

+ + +
+
+
+ +

Returns:

+ + +
+ + + + +
+ 
+
+
+30
+31
+32
+ 		+ 
# File 'doclib/msgpack/unpacker.rb', line 30
+
+def buffer
+  @buffer
+end
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

+ + - (Object) each {|object| ... } + + + + + +

+
+ +

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.

+ + +
+
+
+ +

Yield Parameters:

+
    + +
  • + + object + + + (Object) + + + + — +
    +

    deserialized object

    +
    + +
    • + +
+

Returns:

+
    + +
  • + + + + + + + +
    +

    nil

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+115
+116
+ 		+ 
# File 'doclib/msgpack/unpacker.rb', line 115
+
+def each(&block)
+end
+
+
+ +
+

+ + - (Unpacker) feed(data) + + + + + +

+
+ +

Appends data into the internal buffer. This method calls +buffer.append(data).

+ + +
+
+
+

Parameters:

+
    + +
  • + + data + + + (String) + + + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Unpacker) + + + + — +
    +

    self

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+99
+100
+ 		+ 
# File 'doclib/msgpack/unpacker.rb', line 99
+
+def feed(data)
+end
+
+
+ +
+

+ + - (Object) feed_each(data) {|object| ... } + + + + + +

+
+ +

Appends data into the internal buffer and repeats to deserialize objects. +This method is equals to feed(data) && each.

+ + +
+
+
+

Parameters:

+
    + +
  • + + data + + + (String) + + + +
    • + +
+ +

Yield Parameters:

+
    + +
  • + + object + + + (Object) + + + + — +
    +

    deserialized object

    +
    + +
    • + +
+

Returns:

+
    + +
  • + + + + + + + +
    +

    nil

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+126
+127
+ 		+ 
# File 'doclib/msgpack/unpacker.rb', line 126
+
+def feed_each(data, &block)
+end
+
+
+ +
+

+ + - (Object) read + + + + Also known as: + unpack + + + + +

+
+ +

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 MessagePack::MalformedFormatError. If the +stack is too deep, this method raises MessagePack::StackError.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Object) + + + + — +
    +

    deserialized object

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+41
+42
+ 		+ 
# File 'doclib/msgpack/unpacker.rb', line 41
+
+def read
+end
+
+
+ +
+

+ + - (Integer) read_array_header + + + + + +

+
+ +

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::TypeError. +If there're not enough buffer, this method raises EOFError.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    size of the array

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+77
+78
+ 		+ 
# File 'doclib/msgpack/unpacker.rb', line 77
+
+def read_array_header
+end
+
+
+ +
+

+ + - (Integer) read_map_header + + + + + +

+
+ +

Read 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::TypeError. If +there're not enough buffer, this method raises EOFError.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + + — +
    +

    size of the map

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+89
+90
+ 		+ 
# File 'doclib/msgpack/unpacker.rb', line 89
+
+def read_map_header
+end
+
+
+ +
+

+ + - (Object) skip + + + + + +

+
+ +

Deserializes an object and ignores it. This method is faster than +read.

+ +

This method could raise same errors with read.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + + + + + +
    +

    nil

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+53
+54
+ 		+ 
# File 'doclib/msgpack/unpacker.rb', line 53
+
+def skip
+end
+
+
+ +
+

+ + - (Boolean) skip_nil + + + + + +

+
+ +

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.

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+65
+66
+ 		+ 
# File 'doclib/msgpack/unpacker.rb', line 65
+
+def skip_nil
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/NilClass.html b/NilClass.html new file mode 100644 index 00000000..1615355c --- /dev/null +++ b/NilClass.html @@ -0,0 +1,218 @@ + + + + + + Class: NilClass + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: NilClass + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/core_ext.rb
+ +
+
+ + + + + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + + + +
+

Instance Method Details

+ + +
+

+ + - (String) to_msgpack(io = nil) + + + + + +

+
+ +

Same as MessagePack.to_msgpack(self[, io]).

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    serialized data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+8
+9
+ 		+ 
# File 'doclib/msgpack/core_ext.rb', line 8
+
+def to_msgpack(io=nil)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/String.html b/String.html new file mode 100644 index 00000000..dfa9c706 --- /dev/null +++ b/String.html @@ -0,0 +1,218 @@ + + + + + + Class: String + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: String + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/core_ext.rb
+ +
+
+ + + + + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + + + +
+

Instance Method Details

+ + +
+

+ + - (String) to_msgpack(io = nil) + + + + + +

+
+ +

Same as MessagePack.to_msgpack(self[, io]).

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    serialized data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+68
+69
+ 		+ 
# File 'doclib/msgpack/core_ext.rb', line 68
+
+def to_msgpack(io=nil)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/Symbol.html b/Symbol.html new file mode 100644 index 00000000..31d6ece2 --- /dev/null +++ b/Symbol.html @@ -0,0 +1,218 @@ + + + + + + Class: Symbol + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: Symbol + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/core_ext.rb
+ +
+
+ + + + + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + + + +
+

Instance Method Details

+ + +
+

+ + - (String) to_msgpack(io = nil) + + + + + +

+
+ +

Same as MessagePack.to_msgpack(self[, io]).

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    serialized data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+98
+99
+ 		+ 
# File 'doclib/msgpack/core_ext.rb', line 98
+
+def to_msgpack(io=nil)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/TrueClass.html b/TrueClass.html new file mode 100644 index 00000000..f17857e1 --- /dev/null +++ b/TrueClass.html @@ -0,0 +1,218 @@ + + + + + + Class: TrueClass + + — Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Class: TrueClass + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
doclib/msgpack/core_ext.rb
+ +
+
+ + + + + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + + + +
+

Instance Method Details

+ + +
+

+ + - (String) to_msgpack(io = nil) + + + + + +

+
+ +

Same as MessagePack.to_msgpack(self[, io]).

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + + — +
    +

    serialized data

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+18
+19
+ 		+ 
# File 'doclib/msgpack/core_ext.rb', line 18
+
+def to_msgpack(io=nil)
+end
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/_index.html b/_index.html new file mode 100644 index 00000000..1f0a0208 --- /dev/null +++ b/_index.html @@ -0,0 +1,284 @@ + + + + + + Documentation by YARD 0.8.3 + + + + + + + + + + + + + + + + + + + + + +

Documentation by YARD 0.8.3

+
+

Alphabetic Index

+ +

File Listing

+ + +
+

Namespace Listing A-Z

+ + + + + + + + +
+ + +
    +
  • A
    • + +
+ + +
    +
  • B
    • + +
+ + + + + +
    +
  • H
    • +
      + +
    • + Hash + +
      • + +
    +
+ + + + + + + + +
    +
  • P
    • +
      + +
    • + Packer + + (MessagePack) + +
      • + +
    +
+ + + 		+ + + + + + + + + + +
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/class_list.html b/class_list.html new file mode 100644 index 00000000..0143b61d --- /dev/null +++ b/class_list.html @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + + + +
+

Class List

+ + + + +
+ + diff --git a/css/common.css b/css/common.css new file mode 100644 index 00000000..cf25c452 --- /dev/null +++ b/css/common.css @@ -0,0 +1 @@ +/* Override this file with custom rules */ \ No newline at end of file diff --git a/css/full_list.css b/css/full_list.css new file mode 100644 index 00000000..c918cf19 --- /dev/null +++ b/css/full_list.css @@ -0,0 +1,57 @@ +body { + margin: 0; + font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; + font-size: 13px; + height: 101%; + overflow-x: hidden; +} + +h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; } +.clear { clear: both; } +#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; } +#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; } +#full_list { padding: 0; list-style: none; margin-left: 0; } +#full_list ul { padding: 0; } +#full_list li { padding: 5px; padding-left: 12px; margin: 0; font-size: 1.1em; list-style: none; } +#noresults { padding: 7px 12px; } +#content.insearch #noresults { margin-left: 7px; } +ul.collapsed ul, ul.collapsed li { display: none; } +ul.collapsed.search_uncollapsed { display: block; } +ul.collapsed.search_uncollapsed li { display: list-item; } +li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; } +li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; } +li { color: #888; cursor: pointer; } +li.deprecated { text-decoration: line-through; font-style: italic; } +li.r1 { background: #f0f0f0; } +li.r2 { background: #fafafa; } +li:hover { background: #ddd; } +li small:before { content: "("; } +li small:after { content: ")"; } +li small.search_info { display: none; } +a:link, a:visited { text-decoration: none; color: #05a; } +li.clicked { background: #05a; color: #ccc; } +li.clicked a:link, li.clicked a:visited { color: #eee; } +li.clicked a.toggle { opacity: 0.5; background-position: bottom right; } +li.collapsed.clicked a.toggle { background-position: top right; } +#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; } +#nav { margin-left: 10px; font-size: 0.9em; display: none; color: #aaa; } +#nav a:link, #nav a:visited { color: #358; } +#nav a:hover { background: transparent; color: #5af; } +.frames #nav span:after { content: ' | '; } +.frames #nav span:last-child:after { content: ''; } + +.frames #content h1 { margin-top: 0; } +.frames li { white-space: nowrap; cursor: normal; } +.frames li small { display: block; font-size: 0.8em; } +.frames li small:before { content: ""; } +.frames li small:after { content: ""; } +.frames li small.search_info { display: none; } +.frames #search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; } +.frames #content.insearch #search { background-position: center right; } +.frames #search input { width: 110px; } +.frames #nav { display: block; } + +#full_list.insearch li { display: none; } +#full_list.insearch li.found { display: list-item; padding-left: 10px; } +#full_list.insearch li a.toggle { display: none; } +#full_list.insearch li small.search_info { display: block; } diff --git a/css/style.css b/css/style.css new file mode 100644 index 00000000..ca54c2b8 --- /dev/null +++ b/css/style.css @@ -0,0 +1,328 @@ +body { + padding: 0 20px; + font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; + font-size: 13px; +} +body.frames { padding: 0 5px; } +h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; } +h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; } +h1.title { margin-bottom: 10px; } +h1.alphaindex { margin-top: 0; font-size: 22px; } +h2 { + padding: 0; + padding-bottom: 3px; + border-bottom: 1px #aaa solid; + font-size: 1.4em; + margin: 1.8em 0 0.5em; +} +h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right; } +.clear { clear: both; } +.inline { display: inline; } +.inline p:first-child { display: inline; } +.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; } +.docstring h1 { font-size: 1.2em; } +.docstring h2 { font-size: 1.1em; } +.docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; } +.summary_desc .object_link, .docstring .object_link { font-family: monospace; } +.rdoc-term { padding-right: 25px; font-weight: bold; } +.rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; } + +/* style for