A swath of VERSION patches from Nicholas Clark.

[p5sagit/p5-mst-13.2.git] / lib / Hash / Util.pm

diff --git a/lib/Hash/Util.pm b/lib/Hash/Util.pm
index d5e0a16..658fd86 100644 (file)
--- a/lib/Hash/Util.pm
+++ b/lib/Hash/Util.pm
@@ -9,7 +9,7 @@ our @ISA        = qw(Exporter);
 our @EXPORT_OK  = qw(lock_keys unlock_keys lock_value unlock_value
                      lock_hash unlock_hash
                     );
-our $VERSION    = 0.04;
+our $VERSION    = 0.05;
 
 =head1 NAME
 
@@ -59,8 +59,11 @@ This is intended to largely replace the deprecated pseudo-hashes.
 
 Restricts the given %hash's set of keys to @keys.  If @keys is not
 given it restricts it to its current keyset.  No more keys can be
-added.  delete() and exists() will still work, but it does not effect
-the set of allowed keys.
+added. delete() and exists() will still work, but will not alter
+the set of allowed keys. B<Note>: the current implementation prevents
+the hash from being bless()ed while it is in a locked state. Any attempt
+to do so will raise an exception. Of course you can still bless()
+the hash before you call lock_keys() so this shouldn't be a problem.
 
   unlock_keys(%hash);
 
@@ -175,6 +178,15 @@ sub unlock_hash (\%) {
 
 =back
 
+=head1 CAVEATS
+
+Note that the trapping of the restricted operations is not atomic:
+for example
+
+    eval { %hash = (illegal_key => 1) }
+
+leaves the C<%hash> empty rather than with its original contents.
+
 =head1 AUTHOR
 
 Michael G Schwern <schwern@pobox.com> on top of code by Nick