Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agentzh/lua-resty-multipart-parser
Simple multipart data parser for OpenResty/Lua
https://github.com/agentzh/lua-resty-multipart-parser
Last synced: 8 days ago
JSON representation
Simple multipart data parser for OpenResty/Lua
- Host: GitHub
- URL: https://github.com/agentzh/lua-resty-multipart-parser
- Owner: agentzh
- Created: 2016-10-23T00:15:56.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-10-23T00:47:06.000Z (about 8 years ago)
- Last Synced: 2024-02-13T00:46:42.453Z (9 months ago)
- Language: Lua
- Size: 3.91 KB
- Stars: 38
- Watchers: 6
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-resty - lua-resty-multipart-parser
README
Name
====
lua-resty-multipart-parser - Simple multipart data parser for OpenResty/Lua
Table of Contents
=================
* [Name](#name)
* [Synopsis](#synopsis)
* [Description](#description)
* [TODO](#todo)
* [Community](#community)
* [English Mailing List](#english-mailing-list)
* [Chinese Mailing List](#chinese-mailing-list)
* [Bugs and Patches](#bugs-and-patches)
* [Author](#author)
* [Copyright and License](#copyright-and-license)
Synopsis
========
```lua
local parser = require "resty.multipart.parser"
ngx.req.read_body()
local body = ngx.req.get_body_data()
local p, err = parser.new(body, ngx.var.http_content_type)
if not p then
ngx.say("failed to create parser: ", err)
return
end
while true do
local part_body, name, mime, filename = p:parse_part()
if not part_body then
break
end
ngx.say("== part ==")
ngx.say("name: [", name, "]")
ngx.say("file: [", filename, "]")
ngx.say("mime: [", mime, "]")
ngx.say("body: [", part_body, "]")
end
```
Description
===========
This Lua library provides a simple parser for the multipart data format. Unlike the [lua-resty-upload](https://github.com/openresty/lua-resty-upload) library,
this parser does not support streaming processing of file uploads using the multipart format. However, it is more flexible in that it can be used
to parse buffered request bodies read by the builtin request body reader of the NGINX core.
Anyway, be very careful when using this for large file uploads. Use `lua-resty-upload` instead.
TODO
====
* Better error reporting.
[Back to TOC](#table-of-contents)
Community
=========
[Back to TOC](#table-of-contents)
English Mailing List
--------------------
The [openresty-en](https://groups.google.com/group/openresty-en) mailing list is for English speakers.
[Back to TOC](#table-of-contents)
Chinese Mailing List
--------------------
The [openresty](https://groups.google.com/group/openresty) mailing list is for Chinese speakers.
[Back to TOC](#table-of-contents)
Bugs and Patches
================
Please report bugs or submit patches by
1. creating a ticket on the [GitHub Issue Tracker](https://github.com/openresty/lua-resty-lrucache/issues),
1. or posting to the [OpenResty community](#community).
[Back to TOC](#table-of-contents)
Author
======
Yichun "agentzh" Zhang (章亦春) , CloudFlare Inc.
[Back to TOC](#table-of-contents)
Copyright and License
=====================
This module is licensed under the BSD license.
Copyright (C) 2016, by Yichun "agentzh" Zhang, CloudFlare Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
[Back to TOC](#table-of-contents)