rux::gui::PointsResponse Struct Reference

One points-endpoint response. More...

#include <api.hpp>

Collaboration diagram for rux::gui::PointsResponse:

Public Attributes
std::optional< nlohmann::json >	body
	Set on format=json.
std::optional< Blob >	blob
	Set on format=binary (RUXP v1).
std::vector< std::pair< std::string, std::string > >	headers
	X-Ruxp-* mirrors of the body header, set on the binary path only.

Detailed Description

One points-endpoint response.

Exactly one of body / blob is set, decided by the format parameter — the route needs two different return paths because a RUXP page is not JSON.

Definition at line 238 of file api.hpp.

Member Data Documentation

blob

std::optional<Blob> rux::gui::PointsResponse::blob

Set on format=binary (RUXP v1).

Definition at line 240 of file api.hpp.

body

std::optional<nlohmann::json> rux::gui::PointsResponse::body

Set on format=json.

Definition at line 239 of file api.hpp.

headers

std::vector<std::pair<std::string, std::string> > rux::gui::PointsResponse::headers

X-Ruxp-* mirrors of the body header, set on the binary path only.

A debugging convenience: the body header is the contract, and a client must not depend on these being present (docs/gui/binary-points.md).

Definition at line 244 of file api.hpp.

---

The documentation for this struct was generated from the following file:

• apps/rux/include/gui/api.hpp