Method encode

include/mgmt/rpc/jsonrpc/json/YAMLCodec.h:219–258

@brief Function to encode a single response(no batch) into an emitter. @param resp Response object @param json output yaml emitter

  /// @param json output yaml emitter
  ///
  static void
  encode(const specs::RPCResponseInfo &resp, YAML::Emitter &json)
  {
    json << YAML::BeginMap;
    json << YAML::Key << "jsonrpc" << YAML::Value << specs::JSONRPC_VERSION;

    // Important! As per specs, errors have preference over the result, we ignore result if error was set.

    if (resp.error.ec) {
      // internal library detected error: Decoding, etc.
      encode_error(resp.error.ec, resp.error.data, json);
    }
    // Registered handler error: They have set the error on the response from the registered handler. This uses ExecutionError as
    // top error.
    else if (!resp.callResult.errata.is_ok()) {
      encode_error(resp.callResult.errata, json);
    }
    // A valid response: The registered handler have set the proper result and no error was flagged.
    else {
      json << YAML::Key << "result" << YAML::Value;

      // Could be the case that the registered handler did not set the result. Make sure it was set before inserting it.
      if (!resp.callResult.result.IsNull()) {
        json << resp.callResult.result;
      } else {
        // TODO: do we want to let it return null or by default we put success when there was no error and no result either. Maybe
        // empty?
        json << "success";
      }
    }

    // ID. Only if present.
    if (!resp.id.empty()) {
      json << YAML::Key << "id" << YAML::Value << resp.id;
    }
    // else: We do not insert null as it will break the json, we need literal null and not ~ (as per yaml)
    // json << YAML::Null;

    json << YAML::EndMap;
  }

public:
  ///