Format::Human::Bytes.3pm

Langue: en

Autres versions - même langue

Version: 2009-09-29 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

Format::Human::Bytes - Format a bytecount and make it human readable

VERSION

Version 0.02

SYNOPSIS

Ever showed 12345678 bytes to the user instead of just saying 11MB? This module returns you a printable string which is more readable by humans than a simple bytecount. 
     use Format::Human::Bytes;
 
     $readable = Format::Human::Bytes::base2($bytecount[,$decimals]);
     $readable = Format::Human::Bytes::base10($bytecount[,$decimals]);
 
     $readable = Format::Human::Bytes->base2($bytecount[,$decimals]);
     $readable = Format::Human::Bytes->base10($bytecount[,$decimals]);
 
     my $fhb = Format::Human::Bytes->new();
     $readable = $fhb->base2($bytecount[,$decimals]);
     $readable = $fhb->base10($bytecount[,$decimals]);

FUNCTIONS / METHODS

new

     my $fhb = Format::Human::Bytes->new();

Creates and returns a Format::Human::Bytes - object.

base2

Callable as a function: 
     $readable = Format::Human::Bytes::base2($bytecount[,$decimals]);

Callable as a class method:

     $readable = Format::Human::Bytes->base2($bytecount[,$decimals]);

Callable as a object method:

     $readable = $fhb->base2($bytecount[,$decimals]);

Returns the correct readable form of the given bytecount.

Correct in this case means that 1kB are 1024 Bytes which is how computers see the world.

If you specify a decimal parameter, the result number will have the number of decimal numbers you specified.

base10

Callable as a function: 
     $readable = Format::Human::Bytes::base10($bytecount[,$decimals]);

Callable as a class method:

     $readable = Format::Human::Bytes->base10($bytecount[,$decimals]);

Callable as a object method:

     $readable = $fhb->base10($bytecount[,$decimals]);

Returns the incorrect readable form of the given bytecount.

Incorrect in this case means that 1kB is 1000 Bytes and 1 MB is 1000000 bytes which is how some (many) people see the world, but it's wrong for computers.

If you specify a decimal parameter, the result number will have the number of decimal numbers you specified.

AUTHOR

Sebastian Willing, "<sewi at cpan.org>"

BUGS

Please report any bugs or feature requests to "bug-format-human-bytes at rt.cpan.org", or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Format-Human-Bytes <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Format-Human-Bytes>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command. 
     perldoc Format::Human::Bytes

You can also look for information at:

*
RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=Format-Human-Bytes <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Format-Human-Bytes>

*
AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/Format-Human-Bytes <http://annocpan.org/dist/Format-Human-Bytes>

*
CPAN Ratings

http://cpanratings.perl.org/d/Format-Human-Bytes <http://cpanratings.perl.org/d/Format-Human-Bytes>

*
Search CPAN

http://search.cpan.org/dist/Format-Human-Bytes/ <http://search.cpan.org/dist/Format-Human-Bytes/>

ACKNOWLEDGEMENTS

Copyright 2009 Sebastian Willing, all rights reserved.

This program is released under the following license: gpl