arachnespace::contracts Namespace Reference

Namespaces
namespace	anonymous_namespace{contracts.cpp}

Classes
struct	diagnostic
struct	validation_result

Enumerations
enum class	contract_name {   arachne_batch , batch_envelope , fetch_plan , fetch_request ,   acquired_artifact , research_candidate_graph_plan , product_graph_snapshot , research_candidate_graph_snapshot ,   viewer_projection , site_bundle }

Functions
std::string_view	to_string (contract_name name) noexcept
std::optional< contract_name >	parse_contract_name (std::string_view name) noexcept
bool	is_artifact_bearing (contract_name name) noexcept
validation_result	validate (const nlohmann::json &document)
validation_result	validate (contract_name expected, const nlohmann::json &document)
std::string	canonical_json (const nlohmann::json &document)
validation_result	validate (const json &document)
validation_result	validate (const contract_name expected, const json &document)
std::string	canonical_json (const json &document)

Enumeration Type Documentation

contract_name

enum class arachnespace::contracts::contract_name

strong

Supported active actor-boundary and product-inbox contracts.

Enumerator
arachne_batch
batch_envelope
fetch_plan
fetch_request
acquired_artifact
research_candidate_graph_plan
product_graph_snapshot
research_candidate_graph_snapshot
viewer_projection
site_bundle

Definition at line 14 of file contracts.hpp.

                         {
    arachne_batch,
    batch_envelope,
    fetch_plan,
    fetch_request,
    acquired_artifact,
    research_candidate_graph_plan,
    product_graph_snapshot,
    research_candidate_graph_snapshot,
    viewer_projection,
    site_bundle,
};

Function Documentation

canonical_json() [1/2]

std::string arachnespace::contracts::canonical_json

(

const json &

document

)

Definition at line 2547 of file contracts.cpp.

                                               {
    reject_non_finite(document, "");
    return document.dump(
        -1, ' ', false, nlohmann::json::error_handler_t::strict
    );
}

canonical_json() [2/2]

std::string arachnespace::contracts::canonical_json ( const nlohmann::json & document )

nodiscard

Serialize JSON deterministically: object keys are lexicographically ordered, arrays retain their declared order, UTF-8 is retained, and no insignificant whitespace is emitted.

Exceptions

std::invalid_argument

for discarded or non-finite JSON values.

is_artifact_bearing()

bool arachnespace::contracts::is_artifact_bearing ( contract_name name )

nodiscardnoexcept

Whether the contract necessarily carries or references artifact bytes.

Definition at line 2507 of file contracts.cpp.

                                                            {
    switch (name) {
    case contract_name::batch_envelope:
    case contract_name::fetch_request:
    case contract_name::acquired_artifact:
    case contract_name::research_candidate_graph_plan:
    case contract_name::product_graph_snapshot:
    case contract_name::research_candidate_graph_snapshot:
    case contract_name::viewer_projection:
    case contract_name::site_bundle:
        return true;
    case contract_name::arachne_batch:
    case contract_name::fetch_plan:
        return false;
    }
    return false;
}

References acquired_artifact, arachne_batch, batch_envelope, fetch_plan, fetch_request, product_graph_snapshot, research_candidate_graph_plan, research_candidate_graph_snapshot, site_bundle, and viewer_projection.

parse_contract_name()

std::optional< contract_name > arachnespace::contracts::parse_contract_name ( std::string_view name )

nodiscardnoexcept

Parse an exact, currently supported wire name.

Definition at line 2496 of file contracts.cpp.

                                                        {
    const auto it
        = std::ranges::find_if(contract_names, [name](const auto& item) {
              return item.first == name;
          });
    if (it == contract_names.end()) {
        return std::nullopt;
    }
    return it->second;
}

to_string()

std::string_view arachnespace::contracts::to_string ( contract_name name )

nodiscardnoexcept

Return the canonical wire name, including its major-version suffix.

Definition at line 2487 of file contracts.cpp.

                                                            {
    const auto it
        = std::ranges::find_if(contract_names, [name](const auto& item) {
              return item.second == name;
          });
    return it == contract_names.end() ? std::string_view {} : it->first;
}

validate() [1/4]

validation_result arachnespace::contracts::validate	(	const contract_name	expected,
		const json &	document )

Definition at line 2536 of file contracts.cpp.

                                                                               {
    validation_result result;
    if (!document.is_object()) {
        add(result, "", "type", "contract document must be a JSON object");
        return result;
    }
    validate_header(expected, document, result);
    validate_body(expected, document, result);
    return result;
}

validate() [2/4]

validation_result arachnespace::contracts::validate

(

const json &

document

)

Definition at line 2525 of file contracts.cpp.

                                                 {
    validation_result result;
    const auto name = inspect_contract(document, result);
    if (!name.has_value()) {
        return result;
    }
    validate_header(*name, document, result);
    validate_body(*name, document, result);
    return result;
}

validate() [3/4]

validation_result arachnespace::contracts::validate ( const nlohmann::json & document )

nodiscard

Validate a document after discovering its type from contract, or from format for an Arachne product-inbox batch.

validate() [4/4]

validation_result arachnespace::contracts::validate ( contract_name expected, const nlohmann::json & document )

nodiscard

Validate a document and require the supplied contract type.