created
mach::created
Creates a Created response.
Description
Section titled “Description”Creates a 201 Created response, optionally containing the specified value.
Syntax
Section titled “Syntax”// (1)template <typename T>[[nodiscard]] mach::Reply<T> created(T value);
// (2)[[nodiscard]] mach::Reply<std::string> created(const char* value);
// (3)[[nodiscard]] mach::Reply<> created();Return Value
Section titled “Return Value”Overload (1)
Section titled “Overload (1)”A Created reply containing the specified value.
Overload (2)
Section titled “Overload (2)”A Created reply containing the specified string.
Overload (3)
Section titled “Overload (3)”A Created reply with no value.
Template Parameters
Section titled “Template Parameters”Overload (1)
Section titled “Overload (1)”| Parameter | Description |
|---|---|
T |
The type of the response body. |
Parameters
Section titled “Parameters”Overload (1)
Section titled “Overload (1)”| Parameter | Description |
|---|---|
value |
The response body. |
Overload (2)
Section titled “Overload (2)”| Parameter | Description |
|---|---|
value |
The response body. |
Remarks
Section titled “Remarks”Overload (2) converts the specified value to a std::string.
Examples
Section titled “Examples”Overload (1)
Section titled “Overload (1)”return mach::created(user);Overload (2)
Section titled “Overload (2)”return mach::created("User created.");Overload (3)
Section titled “Overload (3)”return mach::created();See Also
Section titled “See Also”| Name | Description |
|---|---|
Reply |
Represents the result of an HTTP endpoint. |
ControllerBase::created |
Creates a Created response from a controller. |