NAME

Venus::Hash - Hash Class

ABSTRACT

Hash Class for Perl 5

SYNOPSIS

package main;

use Venus::Hash;

my $hash = Venus::Hash->new({1..8});

# $hash->random;

DESCRIPTION

This package provides methods for manipulating hash data.

INHERITS

This package inherits behaviors from:

Venus::Kind::Value

INTEGRATES

This package integrates behaviors from:

Venus::Role::Mappable

METHODS

This package provides the following methods:

all

all(CodeRef $code) (Bool)

The all method returns true if the callback returns true for all of the elements.

Since 0.01

all example 1

# given: synopsis;

my $all = $hash->all(sub {
  $_ > 1
});

# 1

all example 2

# given: synopsis;

my $all = $hash->all(sub {
  my ($key, $value) = @_;

  $value > 1
});

# 1

any

any(CodeRef $code) (Bool)

The any method returns true if the callback returns true for any of the elements.

Since 0.01

any example 1

# given: synopsis;

my $any = $hash->any(sub {
  $_ < 1
});

# 0

any example 2

# given: synopsis;

my $any = $hash->any(sub {
  my ($key, $value) = @_;

  $value < 1
});

# 0

count

count() (Int)

The count method returns the total number of keys defined.

Since 0.01

count example 1

# given: synopsis;

my $count = $hash->count;

# 4

default

default() (HashRef)

The default method returns the default value, i.e. {}.

Since 0.01

default example 1

# given: synopsis;

my $default = $hash->default;

# {}

delete

delete(Str $key) (Any)

The delete method returns the value matching the key specified in the argument and returns the value.

Since 0.01

delete example 1

# given: synopsis;

my $delete = $hash->delete(1);

# 2

each

each(CodeRef $code) (ArrayRef)

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. This method can return a list of values in list-context.

Since 0.01

each example 1

# given: synopsis;

my $each = $hash->each(sub {
  [$_]
});

# [[2], [4], [6], [8]]

each example 2

# given: synopsis;

my $each = $hash->each(sub {
  my ($key, $value) = @_;

  [$key, $value]
});

# [[1, 2], [3, 4], [5, 6], [7, 8]]

empty

empty() (HashRef)

The empty method drops all elements from the hash.

Since 0.01

empty example 1

# given: synopsis;

my $empty = $hash->empty;

# {}

exists

exists(Str $key) (Bool)

The exists method returns true if the value matching the key specified in the argument exists, otherwise returns false.

Since 0.01

exists example 1

# given: synopsis;

my $exists = $hash->exists(1);

# 1

exists example 2

# given: synopsis;

my $exists = $hash->exists(0);

# 0

find

find(Str @data) (Any)

The find method traverses the data structure using the keys and indices provided, returning the value found or undef. In list-context, this method returns a tuple, i.e. the value found and boolean representing whether the match was successful.

Since 0.01

find example 1

package main;

use Venus::Hash;

my $hash = Venus::Hash->new({'foo' => {'bar' => 'baz'},'bar' => ['baz']});

my $find = $hash->find('foo', 'bar');

# "baz"

find example 2

package main;

use Venus::Hash;

my $hash = Venus::Hash->new({'foo' => {'bar' => 'baz'},'bar' => ['baz']});

my $find = $hash->find('bar', 0);

# "baz"

find example 3

package main;

use Venus::Hash;

my $hash = Venus::Hash->new({'foo' => {'bar' => 'baz'},'bar' => ['baz']});

my $find = $hash->find('bar');

# ["baz"]

find example 4

package main;

use Venus::Hash;

my $hash = Venus::Hash->new({'foo' => {'bar' => 'baz'},'bar' => ['baz']});

my ($find, $exists) = $hash->find('baz');

# (undef, 0)

grep

grep(CodeRef $code) (ArrayRef)

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. This method can return a list of values in list-context.

Since 0.01

grep example 1

# given: synopsis;

my $grep = $hash->grep(sub {
  $_ >= 3
});

# [3..8]

grep example 2

# given: synopsis;

my $grep = $hash->grep(sub {
  my ($key, $value) = @_;

  $value >= 3
});

# [3..8]

iterator

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. This method can return a tuple with the key and value in list-context.

Since 0.01

iterator example 1

# given: synopsis;

my $iterator = $hash->iterator;

# sub { ... }

# while (my $value = $iterator->()) {
#   say $value; # 1
# }

iterator example 2

# given: synopsis;

my $iterator = $hash->iterator;

# sub { ... }

# while (grep defined, my ($key, $value) = $iterator->()) {
#   say $value; # 1
# }

keys

keys() (ArrayRef)

The keys method returns an array reference consisting of all the keys in the hash.

Since 0.01

keys example 1

# given: synopsis;

my $keys = $hash->keys;

# [1, 3, 5, 7]

list

list() (Any)

The list method returns a shallow copy of the underlying hash reference as an array reference.

Since 0.01

list example 1

# given: synopsis;

my $list = $hash->list;

# 4

list example 2

# given: synopsis;

my @list = $hash->list;

# (1..8)

map

map(CodeRef $code) (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. This method can return a list of values in list-context.

Since 0.01

map example 1

# given: synopsis;

my $map = $hash->map(sub {
  $_ * 2
});

# [4, 8, 12, 16]

map example 2

# given: synopsis;

my $map = $hash->map(sub {
  my ($key, $value) = @_;

  [$key, ($value * 2)]
});

# [[1, 4], [3, 8], [5, 12], [7, 16]]

merge

merge(HashRef @data) (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.

Since 0.01

merge example 1

# given: synopsis;

my $merge = $hash->merge({1 => 'a'});

# { 1 => "a", 3 => 4, 5 => 6, 7 => 8 }

merge example 2

# given: synopsis;

my $merge = $hash->merge({1 => 'a'}, {5 => 'b'});

# { 1 => "a", 3 => 4, 5 => "b", 7 => 8 }

none

none(CodeRef $code) (Bool)

The none method returns true if none of the elements in the array meet the criteria set by the operand and rvalue.

Since 0.01

none example 1

# given: synopsis;

my $none = $hash->none(sub {
  $_ < 1
});

# 1

none example 2

# given: synopsis;

my $none = $hash->none(sub {
  my ($key, $value) = @_;

  $value < 1
});

# 1

one

one(CodeRef $code) (Bool)

The one method returns true if only one of the elements in the array meet the criteria set by the operand and rvalue.

Since 0.01

one example 1

# given: synopsis;

my $one = $hash->one(sub {
  $_ == 2
});

# 1

one example 2

# given: synopsis;

my $one = $hash->one(sub {
  my ($key, $value) = @_;

  $value == 2
});

# 1

pairs

pairs() (ArrayRef)

The pairs method is an alias to the pairs_array method. This method can return a list of values in list-context.

Since 0.01

pairs example 1

# given: synopsis;

my $pairs = $hash->pairs;

# [[1, 2], [3, 4], [5, 6], [7, 8]]

path

path(Str $expr) (Any)

The path method traverses the data structure using the path expr provided, returning the value found or undef. In list-context, this method returns a tuple, i.e. the value found and boolean representing whether the match was successful.

Since 0.01

path example 1

package main;

use Venus::Hash;

my $hash = Venus::Hash->new({'foo' => {'bar' => 'baz'},'bar' => ['baz']});

my $path = $hash->path('/foo/bar');

# "baz"

path example 2

package main;

use Venus::Hash;

my $hash = Venus::Hash->new({'foo' => {'bar' => 'baz'},'bar' => ['baz']});

my $path = $hash->path('/bar/0');

# "baz"

path example 3

package main;

use Venus::Hash;

my $hash = Venus::Hash->new({'foo' => {'bar' => 'baz'},'bar' => ['baz']});

my $path = $hash->path('/bar');

# ["baz"]

path example 4

package main;

use Venus::Hash;

my $hash = Venus::Hash->new({'foo' => {'bar' => 'baz'},'bar' => ['baz']});

my ($path, $exists) = $hash->path('/baz');

# (undef, 0)

random

random() (Any)

The random method returns a random element from the array.

Since 0.01

random example 1

# given: synopsis;

my $random = $hash->random;

# 6

# my $random = $hash->random;

# 4

reset

reset() (ArrayRef)

The reset method returns nullifies the value of each element in the hash.

Since 0.01

reset example 1

# given: synopsis;

my $reset = $hash->reset;

# { 1 => undef, 3 => undef, 5 => undef, 7 => undef }

reverse

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.

Since 0.01

reverse example 1

# given: synopsis;

my $reverse = $hash->reverse;

# { 2 => 1, 4 => 3, 6 => 5, 8 => 7 }

slice

slice(Str @keys) (ArrayRef)

The slice method returns an array reference of the values that correspond to the key(s) specified in the arguments.

Since 0.01

slice example 1

# given: synopsis;

my $slice = $hash->slice(1, 3);

# [2, 4]

AUTHORS

Cpanery, cpanery@cpan.org

LICENSE

Read the "license" file.

To install Venus, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Venus

CPAN shell

perl -MCPAN -e shell
install Venus

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

ABSTRACT

SYNOPSIS

DESCRIPTION

INHERITS

INTEGRATES

METHODS

all

any

count

default

delete

each

empty

exists

find

grep

iterator

keys

list

map

merge

none

one

pairs

path

random

reset

reverse

slice

AUTHORS

LICENSE

Module Install Instructions