1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
package Format::Human::Bytes;
use warnings;
use strict;
=head1 NAME
Format::Human::Bytes - Format a bytecount and make it human readable
=head1 VERSION
Version 0.06
=cut
our $VERSION = '0.06';
=head1 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]);
All functions do "intelligent" switching to the next unit, for example:
1000 => 1000B
[...]
8000 => 8000B
9000 => 9kB
The difference between 1000 bytes and 1500 bytes is usually bigger (for
example because of a slow link) than between 95kB and 95,5kB. The same
applies to 8000kB vs. 9 MB and for the other units.
Depending on your usage, you may want to specify how many decimals should
be shown (defaults to no decimals).
=head1 FUNCTIONS / METHODS
=head2 new
my $fhb = Format::Human::Bytes->new();
Creates and returns a Format::Human::Bytes - object.
=cut
sub new { # URL
my $class = shift;
my $Scalar;
my $self = bless \$Scalar, $class;
return $self;
}
=head2 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.
=cut
sub base2 {
shift if ref( $_[0] ) ne ''; # Use me as a method if you like
shift
if defined( $_[0] )
and ( $_[0] eq 'Format::Human::Bytes' )
; # Use me as a method if you like
my $Bytes = $_[0] || 0;
defined($Bytes) or $Bytes = 0;
my $Decimal = $_[1] || 0;
if ( $Bytes > 8192000000000 ) {
return sprintf( '%0.' . $Decimal . 'f', $Bytes / 1099511627776 ) . "TB";
}
elsif ( $Bytes > 8192000000 ) {
return sprintf( '%0.' . $Decimal . 'f', $Bytes / 1073741824 ) . "GB";
}
elsif ( $Bytes > 8192000 ) {
return sprintf( '%0.' . $Decimal . 'f', $Bytes / 1048576 ) . "MB";
}
elsif ( $Bytes > 8192 ) {
return sprintf( '%0.' . $Decimal . 'f', $Bytes / 1024 ) . "kB";
}
elsif ( $Bytes == 0 ) { return sprintf( '%0.' . $Decimal . 'f', 0 ); }
else { return sprintf( '%0.' . $Decimal . 'f', $Bytes ) . "B"; }
}
=head2 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.
=cut
sub base10 {
shift if ref( $_[0] ) ne ''; # Use me as a method if you like
shift
if defined( $_[0] )
and ( $_[0] eq 'Format::Human::Bytes' )
; # Use me as a method if you like
my $Bytes = $_[0] || 0;
defined($Bytes) or $Bytes = 0;
my $Decimal = $_[1] || 0;
if ( $Bytes > 8192000000000 ) {
return sprintf( '%0.' . $Decimal . 'f', $Bytes / 1000000000000 ) . "TB";
}
elsif ( $Bytes > 8192000000 ) {
return sprintf( '%0.' . $Decimal . 'f', $Bytes / 1000000000 ) . "GB";
}
elsif ( $Bytes > 8192000 ) {
return sprintf( '%0.' . $Decimal . 'f', $Bytes / 1000000 ) . "MB";
}
elsif ( $Bytes > 8192 ) {
return sprintf( '%0.' . $Decimal . 'f', $Bytes / 1000 ) . "kB";
}
elsif ( $Bytes == 0 ) { return sprintf( '%0.' . $Decimal . 'f', 0 ); }
else { return sprintf( '%0.' . $Decimal . 'f', $Bytes ) . "B"; }
}
=head1 AUTHOR
Sebastian Willing, C<< <sewi at cpan.org> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-format-human-bytes at rt.cpan.org>, or through
the web interface at L<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.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Format::Human::Bytes
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Format-Human-Bytes>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Format-Human-Bytes>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Format-Human-Bytes>
=item * Search CPAN
L<http://search.cpan.org/dist/Format-Human-Bytes/>
=back
=head1 HISTORY
The functions are in use since late 2003 or early 2004 but I didn't pack them
for CPAN before 2009.
=head1 LICENSE
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl 5 itself.
=cut
1; # End of Format::Human::Bytes
|
