# Reader.hpp
This File On Github
Ask A Question
API: latest
module: oatpp
#include "oatpp/web/mime/multipart/Reader.hpp"
# PartReadersMap
Namespace: oatpp::web::mime::multipart
Map of part readers. <part-name> --> <part-reader>
.
typedef std::unordered_map<oatpp::String, std::shared_ptr<PartReader>> PartReadersMap
# PartsParser
In memory multipart parser.
Extends - oatpp::web::mime::multipart::StatefulParser::Listener.
namespace oatpp { namespace web { namespace mime { namespace multipart {
class PartsParser : public StatefulParser::Listener {}
}}}}
# Methods
Return Type | Name | Summary |
---|---|---|
[none] | PartsParser | Constructor. |
# PartsParser::PartsParser
Constructor.
- @param multipart - pointer to oatpp::web::mime::multipart::Multipart.
PartsParser(Multipart* multipart)
# AsyncPartReadersMap
Namespace: oatpp::web::mime::multipart
Map of async part readers. <part-name> --> <part-reader>
.
typedef std::unordered_map<oatpp::String, std::shared_ptr<AsyncPartReader>> AsyncPartReadersMap
# AsyncPartsParser
Async In memory multipart parser.
Extends - oatpp::web::mime::multipart::StatefulParser::AsyncListener.
namespace oatpp { namespace web { namespace mime { namespace multipart {
class AsyncPartsParser : public StatefulParser::AsyncListener {}
}}}}
# Methods
Return Type | Name | Summary |
---|---|---|
[none] | AsyncPartsParser | Constructor. |
# AsyncPartsParser::AsyncPartsParser
Constructor.
- @param multipart - pointer to oatpp::web::mime::multipart::Multipart.
AsyncPartsParser(Multipart* multipart)
# Reader
In memory Multipart reader. Extends - oatpp::data::stream::WriteCallback.
namespace oatpp { namespace web { namespace mime { namespace multipart {
class Reader : public oatpp::data::stream::WriteCallback {}
}}}}
# Methods
Return Type | Name | Summary |
---|---|---|
[none] | Reader | Constructor. |
void | setPartReader | Set named part reader. |
void | setDefaultPartReader | Set default reader for parts. |
# Reader::Reader
Constructor.
- @param multipart - Multipart object to save read data to.
Reader(Multipart* multipart)
# Reader::setPartReader
Set named part reader.
Part with the name == partName
will be read using the specified reader
.
- @param partName - name of the part to read.
- @param reader - reader to read part with.
void setPartReader(const oatpp::String& partName, const std::shared_ptr<PartReader>& reader)
# Reader::setDefaultPartReader
Set default reader for parts.
setPartReader
has precedence.
- @param reader
void setDefaultPartReader(const std::shared_ptr<PartReader>& reader)
# AsyncReader
In memory Multipart reader. Extends - oatpp::data::stream::WriteCallback.
namespace oatpp { namespace web { namespace mime { namespace multipart {
class AsyncReader : public oatpp::data::stream::WriteCallback {}
}}}}
# Methods
Return Type | Name | Summary |
---|---|---|
[none] | AsyncReader | Constructor. |
void | setPartReader | Set named part reader. |
void | setDefaultPartReader | Set default reader for parts. |
# AsyncReader::AsyncReader
Constructor.
- @param multipart - Multipart object to save read data to.
AsyncReader(const std::shared_ptr<Multipart>& multipart)
# AsyncReader::setPartReader
Set named part reader.
Part with the name == partName
will be read using the specified reader
.
- @param partName - name of the part to read.
- @param reader - reader to read part with.
void setPartReader(const oatpp::String& partName, const std::shared_ptr<AsyncPartReader>& reader)
# AsyncReader::setDefaultPartReader
Set default reader for parts.
setPartReader
has precedence.
- @param reader
void setDefaultPartReader(const std::shared_ptr<AsyncPartReader>& reader)