.\" -*- 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::Base64 3pm"
.TH docs::api::APR::Base64 3pm 2024-03-29 "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::Base64 \- Perl API for APR base64 encoding/decoding functionality
.SH Synopsis
.IX Header "Synopsis"
.Vb 1
\&  use APR::Base64 ();
\&  
\&  my $clear   = "foo"
\&  my $encoded = APR::Base64::encode($clear);
\&  my $decoded = APR::Base64::decode($encoded);
\&  my $len_enc = APR::Base64::encode_len(length $clear);
.Ve
.SH Description
.IX Header "Description"
\&\f(CW\*(C`APR::Base64\*(C'\fR provides the access to APR's base64 encoding and
decoding API.
.SH API
.IX Header "API"
\&\f(CW\*(C`APR::Base64\*(C'\fR provides the following functions and/or methods:
.ie n .SS """decode"""
.el .SS \f(CWdecode\fP
.IX Subsection "decode"
Decode a base64 encoded string
.PP
.Vb 1
\&  $decoded = decode($encoded);
.Ve
.ie n .IP "arg1: $encoded ( string )" 4
.el .IP "arg1: \f(CW$encoded\fR ( string )" 4
.IX Item "arg1: $encoded ( string )"
The encoded string.
.ie n .IP "ret: $decoded ( string )" 4
.el .IP "ret: \f(CW$decoded\fR ( string )" 4
.IX Item "ret: $decoded ( string )"
The decoded string.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .SS """encode"""
.el .SS \f(CWencode\fP
.IX Subsection "encode"
Encode a string to base64
.PP
.Vb 1
\&  $encoded = encode($clear);
.Ve
.ie n .IP "arg1: $clear ( string )" 4
.el .IP "arg1: \f(CW$clear\fR ( string )" 4
.IX Item "arg1: $clear ( string )"
The unencoded string.
.ie n .IP "ret: $encoded ( string )" 4
.el .IP "ret: \f(CW$encoded\fR ( string )" 4
.IX Item "ret: $encoded ( string )"
The encoded string.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .SS """encode_len"""
.el .SS \f(CWencode_len\fP
.IX Subsection "encode_len"
Given the length of an unencoded string, get the length of the encoded
string.
.PP
.Vb 1
\&  $len_enc = encode_len($len_clear);
.Ve
.ie n .IP "arg1: $len_clear ( integer )" 4
.el .IP "arg1: \f(CW$len_clear\fR ( integer )" 4
.IX Item "arg1: $len_clear ( integer )"
the length of an unencoded string.
.ie n .IP "ret: $len_enc ( integer )" 4
.el .IP "ret: \f(CW$len_enc\fR ( integer )" 4
.IX Item "ret: $len_enc ( integer )"
the length of the string after it is encoded
.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.