4 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK $AUTOLOAD %EXPORT_TAGS);
9 @ISA = qw(Exporter DynaLoader);
11 # Items to export into callers namespace by default. Note: do not export
12 # names by default without a very good reason. Use EXPORT_OK instead.
13 # Do not simply export all your public functions/methods/constants.
15 # This allows declaration use Devel::Size ':all';
16 # If you do not need this, moving things directly into @EXPORT or @EXPORT_OK
18 %EXPORT_TAGS = ( 'all' => [ qw(
22 @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
29 bootstrap Devel::Size $VERSION;
31 # Preloaded methods go here.
35 # Below is stub documentation for your module. You better edit it!
39 Devel::Size - Perl extension for finding the memory usage of perl variables
43 use Devel::Size qw(size);
44 $size = size("abcde");
45 $other_size = size(\@foo);
47 $foo = {a => [1, 2, 3],
50 $total_size = total_size($foo);
54 This module figures out the real sizes of perl variables. Call it with
55 a reference to the variable you want the size of. If you pass in a
56 plain scalar it returns the size of that scalar. (Just be careful if
57 you're asking for the size of a reference, as it'll follow the
58 reference if you don't reference it first)
60 The C<size> function returns the amount of memory the variable
61 uses. If the variable is a hash or array, it only reports the amount
62 used by the variable structure, I<not> the contents.
64 The C<total_size> function will walk the variable and look at the
65 sizes of the contents. If the variable contains references those
66 references will be walked, so if you have a multidimensional data
67 structure you'll get the total structure size. (There isn't, at the
68 moment, a way to get the size of an array or hash and its elements
77 Doesn't currently walk all the bits for code refs, globs, formats, and
78 IO. Those throw a warning, but a minimum size for them is returned.
82 Dan Sugalski dan@sidhe.org