ignore.hpp

Go to the documentation of this file.

/*
 * Copyright 2020 Robert Bosch GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <string>   // for string
#include <utility>  // for move
 
#include <fable/schema/interface.hpp>  // for Base<>
 
namespace fable::schema {
 
class Ignore : public Base<Ignore> {
 public:  // Constructors
  using Type = struct {};
 
  Ignore() : Base(JsonType::object, "ignored") {}
  explicit Ignore(std::string desc, JsonType t = JsonType::object) : Base(t, std::move(desc)) {}
 
 public:  // Overrides
  [[nodiscard]] Json json_schema() const override {
    Json j = Json::object({});
    this->augment_schema(j);
    return j;
  }
 
  bool validate(const Conf& /*unused*/, std::optional<SchemaError>& /*unused*/) const override { return true; }
  using Interface::to_json;
  void to_json(Json& j) const override { j = nullptr; }
  void from_conf(const Conf& /*unused*/) override {}
  void reset_ptr() override {}
 
  [[nodiscard]] Json serialize(const Type& /*unused*/) const { return nullptr; } // NOLINT(readability-convert-member-functions-to-static)
  [[nodiscard]] Type deserialize(const Conf& /*unused*/) const { return {}; }
  void serialize_into(Json& /*unused*/, const Type& /*unused*/) const {}
  void deserialize_into(const Conf& /*unused*/, Type& /*unused*/) const {}
};
 
inline Ignore make_schema(std::string desc, JsonType t = JsonType::object) {
  return Ignore(std::move(desc), t);
}
 
}  // namespace fable::schema