Data::Object::Hash
Hash Class for Perl 5
package main; use Data::Object::Hash; my $hash = Data::Object::Hash->new({1..4});
This package provides methods for manipulating hash data.
This package inherits behaviors from:
Data::Object::Kind
This package integrates behaviors from:
Data::Object::Role::Dumpable
Data::Object::Role::Proxyable
Data::Object::Role::Throwable
This package uses type constraints from:
Data::Object::Types
This package implements the following methods:
clear() : HashLike
The clear method is an alias to the empty method.
my $hash = Data::Object::Hash->new({1..8}); $hash->clear; # {}
count() : Num
The count method returns the total number of keys defined.
my $hash = Data::Object::Hash->new({1..4}); $hash->count; # 2
defined() : Num
The defined method returns true if the value matching the key specified in the argument if defined, otherwise returns false.
my $hash = Data::Object::Hash->new; $hash->defined;
delete(Num $arg1) : Any
The delete method returns the value matching the key specified in the argument and returns the value.
my $hash = Data::Object::Hash->new({1..8}); $hash->delete(1); # 2
each(CodeRef $arg1, Any @args) : Any
The each method executes callback for each element in the hash passing the routine the key and value at the current position in the loop.
my $hash = Data::Object::Hash->new({1..8}); $hash->each(sub { my ($key, $value) = @_; [$key, $value] });
each_key(CodeRef $arg1, Any @args) : Any
The each_key method executes callback for each element in the hash passing the routine the key at the current position in the loop.
my $hash = Data::Object::Hash->new({1..8}); $hash->each_key(sub { my ($key) = @_; [$key] });
each_n_values(Num $arg1, CodeRef $arg2, Any @args) : Any
The each_n_values method executes callback for each element in the hash passing the routine the next n values until all values have been seen.
my $hash = Data::Object::Hash->new({1..8}); $hash->each_n_values(4, sub { my (@values) = @_; # $values[1] # 2 # $values[2] # 4 # $values[3] # 6 # $values[4] # 8 [@values] });
each_value(CodeRef $arg1, Any @args) : Any
The each_value method executes callback for each element in the hash passing the routine the value at the current position in the loop.
my $hash = Data::Object::Hash->new({1..8}); $hash->each_value(sub { my ($value) = @_; [$value] });
empty() : HashLike
The empty method drops all elements from the hash.
my $hash = Data::Object::Hash->new({1..8}); $hash->empty; # {}
eq(Any $arg1) : Num
The eq method will throw an exception if called.
my $hash = Data::Object::Hash->new; $hash->eq({});
exists(Num $arg1) : Num
The exists method returns true if the value matching the key specified in the argument exists, otherwise returns false.
my $hash = Data::Object::Hash->new({1..8,9,undef}); $hash->exists(1); # 1; true
my $hash = Data::Object::Hash->new({1..8,9,undef}); $hash->exists(0); # 0; false
filter_exclude(Str @args) : HashRef
The filter_exclude method returns a hash reference consisting of all key/value pairs in the hash except for the pairs whose keys are specified in the arguments.
my $hash = Data::Object::Hash->new({1..8}); $hash->filter_exclude(1,3); # {5=>6,7=>8}
filter_include(Str @args) : HashRef
The filter_include method returns a hash reference consisting of only key/value pairs whose keys are specified in the arguments.
my $hash = Data::Object::Hash->new({1..8}); $hash->filter_include(1,3); # {1=>2,3=>4}
fold(Str $arg1, HashRef $arg2, HashRef $arg3) : HashRef
The fold method returns a single-level hash reference consisting of key/value pairs whose keys are paths (using dot-notation where the segments correspond to nested hash keys and array indices) mapped to the nested values.
my $hash = Data::Object::Hash->new({3,[4,5,6],7,{8,8,9,9}}); $hash->fold; # {'3:0'=>4,'3:1'=>5,'3:2'=>6,'7.8'=>8,'7.9'=>9}
ge(Any $arg1) : Num
The ge method will throw an exception if called.
my $hash = Data::Object::Hash->new; $hash->ge({});
get(Str $arg1) : Any
The get method returns the value of the element in the hash whose key corresponds to the key specified in the argument.
my $hash = Data::Object::Hash->new({1..8}); $hash->get(5); # 6
grep(CodeRef $arg1, Any $arg2) : HashRef
The grep method executes callback for each key/value pair in the hash passing the routine the key and value at the current position in the loop and returning a new hash reference containing the elements for which the argument evaluated true.
my $hash = Data::Object::Hash->new({1..4}); $hash->grep(sub { my ($value) = @_; $value >= 3 }); # {3=>4}
gt(Any $arg1) : Num
The gt method will throw an exception if called.
my $hash = Data::Object::Hash->new; $hash->gt({});
head() : Any
The head method will throw an exception if called.
my $hash = Data::Object::Hash->new; $hash->head;
invert() : Any
The invert method returns the hash after inverting the keys and values respectively. Note, keys with undefined values will be dropped, also, this method modifies the hash.
my $hash = Data::Object::Hash->new({1..8,9,undef,10,''}); $hash->invert; # {''=>10,2=>1,4=>3,6=>5,8=>7}
iterator() : CodeRef
The iterator method returns a code reference which can be used to iterate over the hash. Each time the iterator is executed it will return the values of the next element in the hash until all elements have been seen, at which point the iterator will return an undefined value.
my $hash = Data::Object::Hash->new({1..8}); my $iterator = $hash->iterator; # while (my $value = $iterator->next) { # say $value; # 2 # }
join() : Any
The join method will throw an exception if called.
my $hash = Data::Object::Hash->new; $hash->join;
keys() : ArrayRef
The keys method returns an array reference consisting of all the keys in the hash.
my $hash = Data::Object::Hash->new({1..8}); $hash->keys; # [1,3,5,7]
kvslice(Str @args) : HashRef
The kvslice method returns a hash reference containing the elements in the hash at the key(s) specified in the arguments.
my $hash = Data::Object::Hash->new({1..8}); $hash->kvslice(1,5); # {1=>2,5=>6}
le(Any $arg1) : Num
The le method will throw an exception if called.
my $hash = Data::Object::Hash->new; $hash->le;
length() : Num
The length method returns the number of keys in the hash.
my $hash = Data::Object::Hash->new({1..8}); $hash->length; # 4
list() : (Any)
The list method returns a shallow copy of the underlying hash reference as an array reference.
my $hash = Data::Object::Hash->new({1..8}); [$hash->list];
lookup(Str $arg1) : Any
The lookup method returns the value of the element in the hash whose key corresponds to the key specified in the argument. The key can be a string which references (using dot-notation) nested keys within the hash. This method will return undefined if the value is undef or the location expressed in the argument can not be resolved. Please note, keys containing dots (periods) are not handled.
my $hash = Data::Object::Hash->new({1..3,{4,{5,6,7,{8,9,10,11}}}}); $hash->lookup('3.4.7'); # {8=>9,10=>11}
my $hash = Data::Object::Hash->new({1..3,{4,{5,6,7,{8,9,10,11}}}}); $hash->lookup('3.4'); # {5=>6,7=>{8=>9,10=>11}}
my $hash = Data::Object::Hash->new({1..3,{4,{5,6,7,{8,9,10,11}}}}); $hash->lookup(1); # 2
lt(Any $arg1) : Num
The lt method will throw an exception if called.
my $hash = Data::Object::Hash->new; $hash->lt({});
map(CodeRef $arg1, Any $arg2) : ArrayRef
The map method executes callback for each key/value in the hash passing the routine the value at the current position in the loop and returning a new hash reference containing the elements for which the argument returns a value or non-empty list.
my $hash = Data::Object::Hash->new({1..4}); $hash->map(sub { $_[0] + 1 });
merge() : HashRef
The merge method returns a hash reference where the elements in the hash and the elements in the argument(s) are merged. This operation performs a deep merge and clones the datasets to ensure no side-effects. The merge behavior merges hash references only, all other data types are assigned with precendence given to the value being merged.
my $hash = Data::Object::Hash->new({1..8}); $hash->merge({7,7,9,9}); # {1=>2,3=>4,5=>6,7=>7,9=>9}
ne(Any $arg1) : Num
The ne method will throw an exception if called.
my $hash = Data::Object::Hash->new; $hash->ne({});
pairs() : ArrayRef
The pairs method is an alias to the pairs_array method.
my $hash = Data::Object::Hash->new({1..8}); $hash->pairs; # [[1,2],[3,4],[5,6],[7,8]]
reset() : HashLike
The reset method returns nullifies the value of each element in the hash.
my $hash = Data::Object::Hash->new({1..8}); $hash->reset; # {1=>undef,3=>undef,5=>undef,7=>undef}
reverse() : HashRef
The reverse method returns a hash reference consisting of the hash's keys and values inverted. Note, keys with undefined values will be dropped.
my $hash = Data::Object::Hash->new({1..8,9,undef}); $hash->reverse; # {8=>7,6=>5,4=>3,2=>1}
set(Str $arg1, Any $arg2) : Any
The set method returns the value of the element in the hash corresponding to the key specified by the argument after updating it to the value of the second argument.
my $hash = Data::Object::Hash->new({1..8}); $hash->set(1,10); # 10
my $hash = Data::Object::Hash->new({1..8}); $hash->set(1,12); # 12
my $hash = Data::Object::Hash->new({1..8}); $hash->set(1,0); # 0
slice(Str @args) : ArrayRef
The slice method returns an array reference of the values that correspond to the key(s) specified in the arguments.
my $hash = Data::Object::Hash->new({1..8}); $hash->slice(1,3); # [2,4]
sort() : Any
The sort method will throw an exception if called.
my $hash = Data::Object::Hash->new({1..8}); $hash->sort;
tail() : Any
The tail method will throw an exception if called.
my $hash = Data::Object::Hash->new({1..8}); $hash->tail;
unfold() : HashRef
The unfold method processes previously folded hash references and returns an unfolded hash reference where the keys, which are paths (using dot-notation where the segments correspond to nested hash keys and array indices), are used to created nested hash and/or array references.
my $hash = Data::Object::Hash->new( {'3:0'=>4,'3:1'=>5,'3:2'=>6,'7.8'=>8,'7.9'=>9} ); $hash->unfold; # {3=>[4,5,6],7,{8,8,9,9}}
values() : ArrayRef
The values method returns an array reference consisting of the values of the elements in the hash.
my $hash = Data::Object::Hash->new({1..8}); $hash->values; # [2,4,6,8]
Al Newkirk, awncorp@cpan.org
awncorp@cpan.org
Copyright (C) 2011-2019, Al Newkirk, et al.
This is free software; you can redistribute it and/or modify it under the terms of the The Apache License, Version 2.0, as elucidated in the "license file".
Wiki
Project
Initiatives
Milestones
Contributing
Issues
To install Data::Object, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Data::Object
CPAN shell
perl -MCPAN -e shell install Data::Object
For more information on module installation, please visit the detailed CPAN module installation guide.