/ 
Toolforge-MixNMatch-Struct-0.04
River stage one • 1 direct dependent • 1 total dependent
/ Toolforge::MixNMatch::Struct::User

NAME

Toolforge::MixNMatch::Struct::User - Mix'n'match user structure serialization.

SYNOPSIS

use Toolforge::MixNMatch::Struct::User qw(obj2struct struct2obj);

my $struct_hr = obj2struct($obj);
my $obj = struct2obj($struct_hr);

DESCRIPTION

This conversion is between object defined in Toolforge::MixNMatch::Object::User and structure serialized via JSON to Mix'n'match application.

SUBROUTINES

obj2struct

my $struct_hr = obj2struct($obj);

Convert Toolforge::MixNMatch::Object::User instance to structure.

Returns reference to hash with structure.

struct2obj

my $obj = struct2obj($struct_hr);

Convert structure of time to object.

Returns Toolforge::MixNMatch::Object::User instance.

ERRORS

obj2struct():
        Object doesn't exist.
        Object isn't 'Toolforge::MixNMatch::Object::User'.

EXAMPLE1

use strict;
use warnings;

use Data::Printer;
use Toolforge::MixNMatch::Object::User;
use Toolforge::MixNMatch::Struct::User qw(obj2struct);

# Object.
my $obj = Toolforge::MixNMatch::Object::User->new(
        'count' => 6,
        'uid' => 1,
        'username' => 'Skim',
);

# Get structure.
my $struct_hr = obj2struct($obj);

# Dump to output.
p $struct_hr;

# Output:
# \ {
#     cnt        6,
#     uid        1,
#     username   "Skim"
# }

EXAMPLE2

use strict;
use warnings;

use Toolforge::MixNMatch::Struct::User qw(struct2obj);

# Time structure.
my $struct_hr = {
       'cnt' => 6,
       'uid' => 1,
       'username' => 'Skim',
};

# Get object.
my $obj = struct2obj($struct_hr);

# Get count.
my $count = $obj->count;

# Get user UID.
my $uid = $obj->uid;

# Get user name.
my $username = $obj->username;

# Print out.
print "Count: $count\n";
print "User UID: $uid\n";
print "User name: $username\n";

# Output:
# Count: 6
# User UID: 1
# User name: Skim

DEPENDENCIES

Error::Pure, Exporter, Readonly, Toolforge::MixNMatch::Struct::User.

SEE ALSO

Toolforge::MixNMatch::Struct

Toolforge Mix'n'match tool structures.

REPOSITORY

https://github.com/michal-josef-spacek/Toolforge-MixNMatch-Struct

AUTHOR

Michal Josef Špaček mailto:skim@cpan.org

http://skim.cz

LICENSE AND COPYRIGHT

© Michal Josef Špaček 2020

BSD 2-Clause License

VERSION

0.04