summaryrefslogtreecommitdiff
path: root/perl/lib/Data/MessagePack/Unpacker.pod
blob: c24eaf1ddf0cf42c65602c1d87e6613648835be9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
=head1 NAME

Data::MessagePack::Unpacker - messagepack streaming deserializer

=head1 SYNOPSIS

    use Data::Dumper;
    my $up = Data::MessagePack::Unpacker->new;
    my $ret = $up->execute($v, 0);
    if ($ret != length($v)) {
        fail "extra bytes";
    }
    return Dumper($up->data);

=head1 DESCRIPTION

This is an streaming deserializer for messagepack.

=head1 METHODS

=over 4

=item my $up = Data::MessagePack::Unpacker->new()

create new instance of stream deserializer.

=item my $ret = $up->execute($data, $offset);

=item my $ret = $up->execute_limit($data, $offset, $limit)

    $up->execute(substr($data, 0, 3), 0);
    $up->execute($data,               3);

$offset is the offset of $data.

=item my $bool = $up->is_finished();

is this deserializer finished?

=item my $data = $up->data();

returns deserialized object.

=item $up->reset();

reset the stream deserializer, without memory zone.

=back

=head1 AUTHORS

Tokuhiro Matsuno

=head1 SEE ALSO

L<Data::MessagePack>