$darkmode
Public Member Functions | List of all members
fable::schema::Ignore Class Reference

#include <ignore.hpp>

Inheritance diagram for fable::schema::Ignore:
[legend]
Collaboration diagram for fable::schema::Ignore:
[legend]

Public Member Functions

 Ignore (std::string &&desc, JsonType t=JsonType::object)
 
Json json_schema () const override
 
void validate (const Conf &) const override
 
void to_json (Json &j) const override
 
void from_conf (const Conf &) override
 
void reset_ptr () override
 
- Public Member Functions inherited from fable::schema::Base< Ignore >
 Base (JsonType t, std::string &&desc)
 
 Base (JsonType t)
 
 Base (std::string &&desc)
 
Interface * clone () const override
 
 operator Box () const
 
JsonType type () const override
 
std::string type_string () const override
 
Json usage () const override
 
bool is_required () const override
 
Ignore require () &&
 
Ignore required (bool value) &&
 
Ignore reset_pointer () &&
 
bool has_description () const
 
void set_description (const std::string &s) override
 
void set_description (std::string &&s)
 
const std::string & description () const override
 
Ignore description (std::string &&desc) &&
 
- Public Member Functions inherited from fable::schema::Interface
virtual bool is_variant () const
 
virtual bool is_valid (const Conf &c) const
 
virtual Json to_json () const
 

Additional Inherited Members

- Protected Member Functions inherited from fable::schema::Base< Ignore >
void validate_type (const Conf &c) const
 
void throw_error (const Conf &c, const char *format, Args... args) const
 
void throw_error (const ConfError &e) const
 
void throw_wrong_type (const Conf &c) const
 
void augment_schema (Json &j) const
 
- Protected Attributes inherited from fable::schema::Base< Ignore >
JsonType type_
 
bool required_
 
std::string desc_
 

Detailed Description

Ignore always validates true and does not deserialize or serialize types.

This is useful when you want to acknowledge the existence of a key in a JSON object (in the Struct schema type) but do not want to serialize or deserialize it. This is much better than telling Struct to allow all additional properties.

Specifying the type is optional and serves only for documentation purposes.

Member Function Documentation

◆ from_conf()

void fable::schema::Ignore::from_conf ( const Conf &  )
inlineoverridevirtual

Apply the input JSON configuration.

This does not validate the input.

Implements fable::schema::Interface.

◆ json_schema()

Json fable::schema::Ignore::json_schema ( ) const
inlineoverridevirtual

Return the JSON schema.

Example output:

{ "$schema": "http://json-schema.org/draft-07/schema#", "description": "stand-in no-operation simulator", "properties": { "vehicles": { "description": "list of vehicle names to make available", "items": { "type": "string" }, "type": "array" } }, "title": "nop", "additionalProperties": false, "type": "object" }

See the following links for the specification:

Implements fable::schema::Interface.

◆ reset_ptr()

void fable::schema::Ignore::reset_ptr ( )
inlineoverridevirtual

Reset the internal pointer to nullptr, protecting against invalid access.

This should be used when a schema is used after the backing data has been deleted.

Implements fable::schema::Interface.

◆ to_json()

void fable::schema::Ignore::to_json ( Json &  ) const
inlineoverridevirtual

Return the current value of the destination.

Warning: This is NOT an efficient operation, but it can be useful for cases where speed is not important.

Implements fable::schema::Interface.

◆ validate()

void fable::schema::Ignore::validate ( const Conf &  c) const
inlineoverridevirtual

Validate the input JSON configuration.

If you don't have a Conf but would like to validate a Json type, then construct a Conf on the fly: 

s.validate(Conf{j});

This function is not provided inline to prevent incorrect use.

Implements fable::schema::Interface.

Here is the call graph for this function:
The documentation for this class was generated from the following file: