# Part.hpp
This File On Github
Ask A Question
API: latest
module: oatpp
#include "oatpp/web/mime/multipart/Part.hpp"
# Part
One part of the multipart.
namespace oatpp { namespace web { namespace mime { namespace multipart {
class Part {}
}}}}
# Typedefs
Type | Name | Summary |
---|---|---|
oatpp::data::share::LazyStringMultimap<oatpp::data::share::StringKeyLabelCI> | Headers | Typedef for headers map. Headers map key is case-insensitive. For more info see oatpp::data::share::LazyStringMap. |
# Methods
Return Type | Name | Summary |
---|---|---|
[none] | Part | Multiple implementations:
|
void | setPayload | Set payload. |
std::shared_ptr<data::resource::Resource> | getPayload | Get payload. |
oatpp::String | getName | Get name of the part. |
oatpp::String | getFilename | Get filename of the part (if applicable). |
const Headers& | getHeaders | Get request's headers map. |
oatpp::String | getHeader | Get header value |
void | putHeader | Add http header. |
bool | putHeaderIfNotExists | Add http header if not already exists. |
void | setTag | Tag-object - object used to associate some data with the Part. |
const char* | getTagName | Get tag name. |
std::shared_ptr<oatpp::base::Countable> | getTagObject | Get tag object. |
void | clearTag | Clear the tag. |
# Part::Headers
Typedef for headers map. Headers map key is case-insensitive. For more info see oatpp::data::share::LazyStringMap.
typedef oatpp::data::share::LazyStringMultimap<oatpp::data::share::StringKeyLabelCI> Headers
# Part::Part
- Default constructor.
Part() = default
- Constructor.
- @param headers - headers of the part.
- @param payload - part payload.
Part(const Headers& headers, const std::shared_ptr<data::resource::Resource>& payload = nullptr)
# Part::setPayload
Set payload.
- @param payload
void setPayload(const std::shared_ptr<data::resource::Resource>& payload)
# Part::getPayload
Get payload.
- @return
std::shared_ptr<data::resource::Resource> getPayload()
# Part::getName
Get name of the part.
- @return - name of the part.
oatpp::String getName() const
# Part::getFilename
Get filename of the part (if applicable).
- @return - filename.
oatpp::String getFilename() const
# Part::getHeaders
Get request's headers map.
- @return Headers map
const Headers& getHeaders() const
# Part::getHeader
Get header value
- @param headerName
- @return header value
oatpp::String getHeader(const oatpp::data::share::StringKeyLabelCI& headerName) const
# Part::putHeader
Add http header.
- @param key - oatpp::data::share::StringKeyLabelCI.
- @param value - oatpp::data::share::StringKeyLabel.
void putHeader(const oatpp::data::share::StringKeyLabelCI& key, const oatpp::data::share::StringKeyLabel& value)
# Part::putHeaderIfNotExists
Add http header if not already exists.
- @param key - oatpp::data::share::StringKeyLabelCI.
- @param value - oatpp::data::share::StringKeyLabel.
- @return -
true
if header was added.
bool putHeaderIfNotExists(const oatpp::data::share::StringKeyLabelCI& key, const oatpp::data::share::StringKeyLabel& value)
# Part::setTag
Tag-object - object used to associate some data with the Part.
Ex.: used by oatpp::web::mime::multipart::InMemoryPartReader. to associate intermediate buffer with the part.
- @param tagName
- @param tagObject
void setTag(const char* tagName, const std::shared_ptr<oatpp::base::Countable>& tagObject)
# Part::getTagName
Get tag name.
- @return
const char* getTagName()
# Part::getTagObject
Get tag object.
- @return
std::shared_ptr<oatpp::base::Countable> getTagObject()
# Part::clearTag
Clear the tag.
void clearTag()