.\" -*- 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::UUID 3pm"
.TH docs::api::APR::UUID 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::UUID \- Perl API for manipulating APR UUIDs
.SH Synopsis
.IX Header "Synopsis"
.Vb 1
\&  use APR::UUID ();
\&  
\&  # get a random UUID and format it as a string
\&  my $uuid = APR::UUID\->new\->format;
\&  # $uuid = e.g. \*(Aqd48889bb\-d11d\-b211\-8567\-ec81968c93c6\*(Aq;
\&  
\&  # same as the object returned by APR::UUID\->new
\&  my $uuid_parsed = APR::UUID\->parse($uuid);
.Ve
.SH Description
.IX Header "Description"
\&\f(CW\*(C`APR::UUID\*(C'\fR is used to get and manipulate random UUIDs.
.PP
It allows you to \f(CW\*(C`create\*(C'\fR random UUIDs, which when
\&\f(CW\*(C`formatted\*(C'\fR returns a string like:
.PP
.Vb 1
\&  \*(Aqd48889bb\-d11d\-b211\-8567\-ec81968c93c6\*(Aq;
.Ve
.PP
which can be parsed back into the \f(CW\*(C`APR::UUID\*(C'\fR object with
\&\f(CWparse()\fR.
.SH API
.IX Header "API"
\&\f(CW\*(C`APR::UUID\*(C'\fR provides the following functions and/or methods:
.ie n .SS """format"""
.el .SS \f(CWformat\fP
.IX Subsection "format"
Convert an \f(CW\*(C`APR::UUID object\*(C'\fR object
into a string presentation:
.PP
.Vb 1
\&  my $uuid_str = $uuid\->format;
.Ve
.ie n .IP "obj: $uuid ( ""APR::UUID object"" )" 4
.el .IP "obj: \f(CW$uuid\fR ( \f(CWAPR::UUID object\fR )" 4
.IX Item "obj: $uuid ( APR::UUID object )"
.PD 0
.ie n .IP "ret: $uuid_str" 4
.el .IP "ret: \f(CW$uuid_str\fR" 4
.IX Item "ret: $uuid_str"
.PD
returns a string representation of the object (.e.g
\&\f(CW\*(Aqd48889bb\-d11d\-b211\-8567\-ec81968c93c6\*(Aq\fR).
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .SS """new"""
.el .SS \f(CWnew\fP
.IX Subsection "new"
Create a \f(CW\*(C`APR::UUID object\*(C'\fR using the
random engine:
.PP
.Vb 1
\&  my $uuid = APR::UUID\->new;
.Ve
.ie n .IP "class: ""APR::UUID"" ( ""APR::UUID class"" )" 4
.el .IP "class: \f(CWAPR::UUID\fR ( \f(CWAPR::UUID class\fR )" 4
.IX Item "class: APR::UUID ( APR::UUID class )"
.PD 0
.ie n .IP "ret: $uuid ( ""APR::UUID object"" )" 4
.el .IP "ret: \f(CW$uuid\fR ( \f(CWAPR::UUID object\fR )" 4
.IX Item "ret: $uuid ( APR::UUID object )"
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.ie n .SS """DESTROY"""
.el .SS \f(CWDESTROY\fP
.IX Subsection "DESTROY"
.Vb 1
\&  $uuid\->DESTROY;
.Ve
.ie n .IP "obj: ""APR::UUID"" ( ""APR::UUID object"" )" 4
.el .IP "obj: \f(CWAPR::UUID\fR ( \f(CWAPR::UUID object\fR )" 4
.IX Item "obj: APR::UUID ( APR::UUID object )"
.PD 0
.IP "ret: no return value" 4
.IX Item "ret: no return value"
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.PP
Do not call this method, it's designed to be only called by Perl when
the variable goes out of scope. If you call it yourself you will get a
segfault when perl will call DESTROY on its own.
.ie n .SS """parse"""
.el .SS \f(CWparse\fP
.IX Subsection "parse"
Convert a UUID string into an \f(CW\*(C`APR::UUID
object\*(C'\fR object:
.PP
.Vb 1
\&  $uuid = APR::UUID\->parse($uuid_str)
.Ve
.ie n .IP "arg1: $uuid_str (string)" 4
.el .IP "arg1: \f(CW$uuid_str\fR (string)" 4
.IX Item "arg1: $uuid_str (string)"
UUID string (.e.g \f(CW\*(Aqd48889bb\-d11d\-b211\-8567\-ec81968c93c6\*(Aq\fR)
.ie n .IP "ret: $uuid ( ""APR::UUID object"" )" 4
.el .IP "ret: \f(CW$uuid\fR ( \f(CWAPR::UUID object\fR )" 4
.IX Item "ret: $uuid ( APR::UUID object )"
The new object.
.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.