GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  DATA::PERL::ROLE::COLLECTION::HASH (3)

.ds Aq ’

NAME

Data::Perl::Role::Collection::Hash - Wrapping class for Perl’s built in hash structure.

CONTENTS

VERSION

version 0.002009

SYNOPSIS



  use Data::Perl qw/hash/;

  my $hash = hash(a => 1, b => 2);

  $hash->values; # (1, 2)

  $hash->set(foo, bar); # (a => 1, b => 2, foo => bar)



DESCRIPTION

This class provides a wrapper and methods for interacting with a hash. All methods that return a list do so via a Data::Perl::Collection::Array object.

PROVIDED METHODS

<B>new($key, B>$value<B>, ...)B> Given an optional list of keys/values, constructs a new Data::Perl::Collection::Hash object initalized with keys/values and returns it.
<B>get($key, B>$key2<B>, B>$key3<B>...)B> Returns a list of values in the hash for the given keys.

This method requires at least one argument.

<B>set($key => B>$value<B>, B>$key2<B> => B>$value2<B>...)B> Sets the elements in the hash to the given values. It returns the new values set for each key, in the same order as the keys passed to the method.

This method requires at least two arguments, and expects an even number of arguments.

<B>delete($key, B>$key2<B>, B>$key3<B>...)B> Removes the elements with the given keys.

Returns a list of values in the hash for the deleted keys.

<B>keysB> Returns the list of keys in the hash.

This method does not accept any arguments.

<B>exists($key)B> Returns true if the given key is present in the hash.

This method requires a single argument.

<B>defined($key)B> Returns true if the value of a given key is defined.

This method requires a single argument.

<B>valuesB> Returns the list of values in the hash.

This method does not accept any arguments.

<B>kvB> Returns the key/value pairs in the hash as an array of array references.



  for my $pair ( $object->option_pairs ) {
      print "$pair->[0] = $pair->[1]\n";
  }



This method does not accept any arguments.

<B>elements/allB> Returns the key/value pairs in the hash as a flattened list..

This method does not accept any arguments.

<B>clearB> Resets the hash to an empty value, like %hash = ().

This method does not accept any arguments.

<B>countB> Returns the number of elements in the hash. Also useful for not empty: has_options => count.

This method does not accept any arguments.

<B>is_emptyB> If the hash is populated, returns false. Otherwise, returns true.

This method does not accept any arguments.

<B>accessor($key)B>
<B>accessor($key, B>$value<B>)B> If passed one argument, returns the value of the specified key. If passed two arguments, sets the value of the specified key.

When called as a setter, this method returns the value that was set.

<B>shallow_cloneB> This method returns a shallow clone of the hash reference. The return value is a reference to a new hash with the same keys and values. It is shallow because any values that were references in the original will be the same references in the clone.
<B>_array_classB> The name of the class which returned lists are instances of; i.e. Data::Perl::Collection::Array.

Subclasses of this class can override this method.

Note that each is deliberately omitted, due to its stateful interaction with the hash iterator. keys or kv are much safer.

SEE ALSO

o Data::Perl
o MooX::HandlesVia

AUTHOR

Matthew Phillips <mattp@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Matthew Phillips <mattp@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 DATA::PERL::ROLE::COLLECTION::HASH (3) 2014-06-27

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.