.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "docs::api::APR::String 3pm"
.TH docs::api::APR::String 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
APR::String \- Perl API for manipulating APR UUIDs
.SH Synopsis
.IX Header "Synopsis"
.Vb 1
\&  use APR::String ();
\&  
\&  # 42_000 => " 41K",
\&  my $size_str = APR::String::format_size($size);
.Ve
.SH Description
.IX Header "Description"
\&\f(CW\*(C`APR::String\*(C'\fR provides strings manipulation API.
.SH API
.IX Header "API"
\&\f(CW\*(C`APR::String\*(C'\fR provides the following functions and/or methods:
.ie n .SS """format_size"""
.el .SS \f(CWformat_size\fP
.IX Subsection "format_size"
.Vb 1
\&  my $size_str = APR::String::format_size($size);
.Ve
.ie n .IP "arg1: $size ( integer )" 4
.el .IP "arg1: \f(CW$size\fR ( integer )" 4
.IX Item "arg1: $size ( integer )"
.PD 0
.ie n .IP "ret: $size_str" 4
.el .IP "ret: \f(CW$size_str\fR" 4
.IX Item "ret: $size_str"
.PD
returns a formatted size string representation of a number.  The size
given in the string will be in units of bytes, kilobytes, or
megabytes, depending on the size. The length of that string is always
4 chars long. For example:
.Sp
.Vb 4
\&    0               => "  0 ",
\&    42              => " 42 ",
\&    42_000          => " 41K",
\&    42_000_000      => " 40M",
.Ve
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.SH "See Also"
.IX Header "See Also"
mod_perl 2.0 documentation.
.SH Copyright
.IX Header "Copyright"
mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 2.0.
.SH Authors
.IX Header "Authors"
The mod_perl development team and numerous
contributors.