---
name: "APR::Request::Parser"
section: "3pm"
platform: "linux"
package: "libapreq2-doc"
version: "2.17-7"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/APR::Request::Parser"
---

# APR::Request::Parser(3pm)

wrapper for libapreq2's parser API.

## NAME

APR::Request::Parser - wrapper for libapreq2's parser API.

## SYNOPSIS

```
  use APR::Request::Parser;
```

## DESCRIPTION

This manpage documents version 2.17 of the APR::Request::Parser package.

## METHODS

APR::Request::Parser

### generic

```
    APR::Request::Parser->generic($pool, $ba, $ct)
    APR::Request::Parser->generic($pool, $ba, $ct, $blim)
    APR::Request::Parser->generic($pool, $ba, $ct, $blim, $tdir)
    APR::Request::Parser->generic($pool, $ba, $ct, $blim, $tdir, $hook)
```

Noop-parser that collects everything into a single, internal parameter.  Here `$pool` is an APR::Pool object, `$ba` is an APR::BucketAlloc object, and `$ct` is the Content-Type header of the request.  Optionally `$blim` is the brigade in-memory limit, `$tdir` is the path to the temporary directory, and `$hook` is an  APR::Request::Hook object.

### headers

```
    APR::Request::Parser->headers($pool, $ba, $ct)
    APR::Request::Parser->headers($pool, $ba, $ct, $blim)
    APR::Request::Parser->headers($pool, $ba, $ct, $blim, $tdir)
    APR::Request::Parser->headers($pool, $ba, $ct, $blim, $tdir, $hook)
```

RFC 822 header parser.  Here `$pool` is an APR::Pool object, `$ba` is an APR::BucketAlloc object, and `$ct` is the Content-Type header of the request.  Optionally `$blim` is the brigade in-memory limit, `$tdir` is the path to the temporary directory, and `$hook` is an  APR::Request::Hook object.

### urlencoded

```
    APR::Request::Parser->urlencoded($pool, $ba, $ct)
    APR::Request::Parser->urlencoded($pool, $ba, $ct, $blim)
    APR::Request::Parser->urlencoded($pool, $ba, $ct, $blim, $tdir)
    APR::Request::Parser->urlencoded($pool, $ba, $ct, $blim, $tdir, $hook)
```

x-www-form-urlencoded parser.  Here `$pool` is an APR::Pool object, `$ba` is an APR::BucketAlloc object, and `$ct` is the Content-Type header of the request.  Optionally `$blim` is the brigade in-memory limit, `$tdir` is the path to the temporary directory, and `$hook` is an  APR::Request::Hook object.

### multipart

```
    APR::Request::Parser->multipart($pool, $ba, $ct)
    APR::Request::Parser->multipart($pool, $ba, $ct, $blim)
    APR::Request::Parser->multipart($pool, $ba, $ct, $blim, $tdir)
    APR::Request::Parser->multipart($pool, $ba, $ct, $blim, $tdir, $hook)
```

Multipart parser.  Here `$pool` is an APR::Pool object, `$ba` is an APR::BucketAlloc object, and `$ct` is the Content-Type header of the request.  Optionally `$blim` is the brigade in-memory limit, `$tdir` is the path to the temporary directory, and `$hook` is an  APR::Request::Hook object.

### default

```
    APR::Request::Parser->default($pool, $ba, $ct)
    APR::Request::Parser->default($pool, $ba, $ct, $blim)
    APR::Request::Parser->default($pool, $ba, $ct, $blim, $tdir)
    APR::Request::Parser->default($pool, $ba, $ct, $blim, $tdir, $hook)
```

Default parser.  Here `$pool` is an APR::Pool object, `$ba` is an APR::BucketAlloc object, and `$ct` is the Content-Type header of the request.  Optionally `$blim` is the brigade in-memory limit, `$tdir` is the path to the temporary directory, and `$hook` is an  APR::Request::Hook object.

## SEE ALSO

APR::Request, APR::Request::Hook

## COPYRIGHT

```
  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at
      http://www.apache.org/licenses/LICENSE-2.0
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
```
