The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Data::MessagePack::Unpacker - messagepack streaming deserializer

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

DESCRIPTION

This is a streaming deserializer for messagepack.

METHODS

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

creates a new instance of stream deserializer.

$up->utf8([$bool])

sets utf8 mode. true if $bool is omitted. returns $up itself.

If utf8 mode is enabled, strings will be decoded as UTF-8.

The utf8 mode is disabled by default.

my $ret = $up->get_utf8()

returns the utf8 mode flag of $up.

my $ret = $up->execute($data, $offset);
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.

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

is this deserializer finished?

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

returns the deserialized object.

$up->reset();

resets the stream deserializer, without memory zone.

AUTHORS

Tokuhiro Matsuno

SEE ALSO

Data::MessagePack