From c320e44a236762d73677bbf5780f8c3a42fd98ff Mon Sep 17 00:00:00 2001
From: "Fuji, Goro" <gfuji@cpan.org>
Date: Thu, 28 Oct 2010 17:26:04 +0900
Subject: [PATCH] perl: update Unpacker.pod

---
 perl/lib/Data/MessagePack/Unpacker.pod | 26 ++++++++++++++++----------
 1 file changed, 16 insertions(+), 10 deletions(-)

diff --git a/perl/lib/Data/MessagePack/Unpacker.pod b/perl/lib/Data/MessagePack/Unpacker.pod
index 24dafd00..04cb0a47 100644
--- a/perl/lib/Data/MessagePack/Unpacker.pod
+++ b/perl/lib/Data/MessagePack/Unpacker.pod
@@ -6,11 +6,16 @@ Data::MessagePack::Unpacker - messagepack streaming deserializer
 
     use Data::Dumper;
     my $up = Data::MessagePack::Unpacker->new;
-    my $ret = $up->execute($v, 0);
-    if ($ret != length($v)) {
-        fail "extra bytes";
+
+    open my $fh, $data or die $!;
+
+    my $offset = 0;
+    while( read($fh, my $buf, 1024) ) {
+        $offset = $up->execute($buf, $offset);
+        if($up->is_finished) {
+            print Dumper($up->data);
+        }
     }
-    return Dumper($up->data);
 
 =head1 DESCRIPTION
 
@@ -22,7 +27,7 @@ This is a streaming deserializer for messagepack.
 
 =item my $up = Data::MessagePack::Unpacker->new()
 
-creates a new instance of stream deserializer.
+creates a new instance of the stream deserializer.
 
 =item $up->utf8([$bool])
 
@@ -37,14 +42,15 @@ The utf8 mode is disabled by default.
 
 returns the utf8 mode flag of I<$up>.
 
-=item my $ret = $up->execute($data, $offset);
+=item $offset = $up->execute($data, $offset);
 
-=item my $ret = $up->execute_limit($data, $offset, $limit)
+=item $offset = $up->execute_limit($data, $offset, $limit)
 
-    $up->execute(substr($data, 0, 3), 0);
-    $up->execute($data,               3);
+parses unpacked I<$data> from I<$offset> to I<$limit>.
+returns a new offset of I<$data>, which is for the next <execute()>.
 
-$offset is the offset of $data.
+If I<$data> is insufficient, I<$offset> does not change, saving
+I<$data> in internal buffers.
 
 =item my $bool = $up->is_finished();