prf::control::schema namespace

Classes

struct DescriptorView
struct FieldSpec

Functions

auto append_schema_catalog(ResponseWriter*const out, const std::string_view path, const std::span<const DescriptorView> descriptors, const std::string_view relative_to) -> bool
Appends full kind=schema_catalog response in arrays-first wire model.
auto append_schema_catalog(ResponseWriter*const out, const std::string_view path, const std::span<const prf::control::CommandDescriptor> commands, const std::string_view relative_to) -> bool
Appends full kind=schema_catalog response in arrays-first wire model.
auto append_schema_target(ResponseWriter*const out, const std::string_view path, const std::span<const char*const> targets, const std::span<const FieldSpec> fields) -> bool
auto append_schema_target(ResponseWriter*const out, const std::string_view path, const std::span<const char*const> targets, const std::span<const prf::config::SectionKeySpec> key_specs, const prf::control::protocol::wire::AccessMode config_access, const std::span<const FieldSpec> runtime_fields) -> bool
auto append_schema_target(ResponseWriter* out, std::string_view path, std::span<const char*const> targets, std::span<const FieldSpec> fields) -> bool
Appends full kind=schema_target response in arrays-first wire model.
auto append_schema_target(ResponseWriter* out, std::string_view path, std::span<const char*const> targets, std::span<const prf::config::SectionKeySpec> key_specs, prf::control::protocol::wire::AccessMode config_access = prf::control::protocol::wire::AccessMode::ReadWrite, std::span<const FieldSpec> runtime_fields = {}) -> bool
Appends full kind=schema_target response in arrays-first wire model.
auto auth_policy_name(const prf::control::AuthPolicy policy) -> const char*
Stable string form used by introspection replies.
auto auth_policy_wire(const prf::control::AuthPolicy policy) -> prf::control::protocol::wire::AuthPolicy
Converts auth policy to compact wire enum.
auto config_schema_type_name(const prf::config::SectionKeySpec& spec) -> const char*
Stable string form used by introspection replies for one schema key.
auto config_schema_wire_type(const prf::config::SectionKeySpec& spec) -> prf::control::protocol::wire::WireType
Converts section key schema/default type to compact wire enum.
auto config_value_type_name(const prf::config::ConfigValueType type) -> const char*
Stable string form used by introspection replies.
auto field_spec_from_config_key(const prf::config::SectionKeySpec& spec, const prf::control::protocol::wire::AccessMode access) -> FieldSpec
Converts one config key spec to unified schema field metadata.
auto match_mode_name(const prf::control::MatchMode mode) -> const char*
Stable string form used by introspection replies.
auto match_mode_wire(const prf::control::MatchMode mode) -> prf::control::protocol::wire::MatchMode
Converts match mode to compact wire enum.

Function documentation

bool prf::control::schema::append_schema_catalog(ResponseWriter*const out, const std::string_view path, const std::span<const DescriptorView> descriptors, const std::string_view relative_to)
#include <control/schema.hpp>

Appends full kind=schema_catalog response in arrays-first wire model.

bool prf::control::schema::append_schema_catalog(ResponseWriter*const out, const std::string_view path, const std::span<const prf::control::CommandDescriptor> commands, const std::string_view relative_to)
#include <control/schema.hpp>

Appends full kind=schema_catalog response in arrays-first wire model.

bool prf::control::schema::append_schema_target(ResponseWriter*const out, const std::string_view path, const std::span<const char*const> targets, const std::span<const FieldSpec> fields)
#include <control/schema.cpp>

bool prf::control::schema::append_schema_target(ResponseWriter*const out, const std::string_view path, const std::span<const char*const> targets, const std::span<const prf::config::SectionKeySpec> key_specs, const prf::control::protocol::wire::AccessMode config_access, const std::span<const FieldSpec> runtime_fields)
#include <control/schema.cpp>

bool prf::control::schema::append_schema_target(ResponseWriter* out, std::string_view path, std::span<const char*const> targets, std::span<const FieldSpec> fields)
#include <control/schema.hpp>

Appends full kind=schema_target response in arrays-first wire model.

bool prf::control::schema::append_schema_target(ResponseWriter* out, std::string_view path, std::span<const char*const> targets, std::span<const prf::config::SectionKeySpec> key_specs, prf::control::protocol::wire::AccessMode config_access = prf::control::protocol::wire::AccessMode::ReadWrite, std::span<const FieldSpec> runtime_fields = {})
#include <control/schema.hpp>

Appends full kind=schema_target response in arrays-first wire model.

const char* prf::control::schema::auth_policy_name(const prf::control::AuthPolicy policy)
#include <control/schema.hpp>

Stable string form used by introspection replies.

prf::control::protocol::wire::AuthPolicy prf::control::schema::auth_policy_wire(const prf::control::AuthPolicy policy)
#include <control/schema.hpp>

Converts auth policy to compact wire enum.

const char* prf::control::schema::config_schema_type_name(const prf::config::SectionKeySpec& spec)
#include <control/schema.hpp>

Stable string form used by introspection replies for one schema key.

prf::control::protocol::wire::WireType prf::control::schema::config_schema_wire_type(const prf::config::SectionKeySpec& spec)
#include <control/schema.hpp>

Converts section key schema/default type to compact wire enum.

const char* prf::control::schema::config_value_type_name(const prf::config::ConfigValueType type)
#include <control/schema.hpp>

Stable string form used by introspection replies.

FieldSpec prf::control::schema::field_spec_from_config_key(const prf::config::SectionKeySpec& spec, const prf::control::protocol::wire::AccessMode access)
#include <control/schema.hpp>

Converts one config key spec to unified schema field metadata.

const char* prf::control::schema::match_mode_name(const prf::control::MatchMode mode)
#include <control/schema.hpp>

Stable string form used by introspection replies.

prf::control::protocol::wire::MatchMode prf::control::schema::match_mode_wire(const prf::control::MatchMode mode)
#include <control/schema.hpp>

Converts match mode to compact wire enum.