Parsnip
parsing library
Loading...
Searching...
No Matches
Public Member Functions
Parsnip::IntegerSchema Class Reference
Inheritance diagram for Parsnip::IntegerSchema:
Parsnip::RangeSchema< long > Parsnip::SchemaBase

Public Member Functions

 IntegerSchema (const Parsnip::Data &schema_spec)
 Construct an integer schema from a schema specification.
 
virtual IntegerSchemacreateCopy () const override
 Create an identical, deep copy of the schema.
 
virtual bool operator== (const SchemaBase &other) const override
 Check if two schemas perform the same validation.
 
virtual void validate (const Parsnip::Data &entry) const override
 Validate item range: ensure the datatype falls within the allowed range.
 
- Public Member Functions inherited from Parsnip::RangeSchema< long >
 RangeSchema (const long min=std::numeric_limits< long >::lowest(), const long max=std::numeric_limits< long >::max())
 Construct a numeric schema from a schema definition.
 
 RangeSchema (const RangeSchema &)=default
 
 RangeSchema (RangeSchema &&)=default
 
 RangeSchema (const Parsnip::Data &schema_spec)
 Construct a numeric schema from a schema definition.
 
RangeSchemaoperator= (const RangeSchema &)=default
 
RangeSchemaoperator= (RangeSchema &&)=default
 
virtual void mergeSchemas (const SchemaBase &from) override
 Merge elements into the current schema.
 
virtual std::ostream & dump (std::ostream &target, int indent, bool suppress_ident=false) const override
 Render the schema in human-friendly text.
 
- Public Member Functions inherited from Parsnip::SchemaBase
bool operator!= (const SchemaBase &other) const
 

Additional Inherited Members

- Public Types inherited from Parsnip::RangeSchema< long >
using value_type = long
 
- Protected Types inherited from Parsnip::SchemaBase
using StringType = Data::StringType
 
using SchemaRegex = std::basic_regex< StringType::value_type >
 
- Protected Member Functions inherited from Parsnip::SchemaBase
 SchemaBase (const SchemaBase &)=default
 
 SchemaBase (SchemaBase &&)=default
 
SchemaBaseoperator= (const SchemaBase &)=default
 
SchemaBaseoperator= (SchemaBase &&)=default
 
 SchemaBase (const Parsnip::Data &schema_spec)
 Construct a schema from a JSON specification.
 
void checkType (Data::Type expected, const Parsnip::Data &entry) const
 Check that Data item is an allowed type.
 
bool isValidlyNull (const Parsnip::Data &entry) const
 Determine if the data is Null and if that is allowed.
 
bool isType (Data::Type expected, const Parsnip::Data &entry) const
 Check if a data object is a particular type.
 
- Protected Attributes inherited from Parsnip::SchemaBase
bool nullable = false
 If true, element may be null.
 

Member Function Documentation

◆ createCopy()

IntegerSchema * Parsnip::IntegerSchema::createCopy ( ) const
overridevirtual

Create an identical, deep copy of the schema.

Caller is responsible for deleting it.

Reimplemented from Parsnip::RangeSchema< long >.

◆ operator==()

bool Parsnip::IntegerSchema::operator== ( const SchemaBase other) const
overridevirtual

Check if two schemas perform the same validation.

Compare two schemas to see if they determine validity in the same manner.

Parameters
otherThe schema to compare to.
Returns
True if the schemas match, false otherwise.

Reimplemented from Parsnip::RangeSchema< long >.

◆ validate()

void Parsnip::IntegerSchema::validate ( const Parsnip::Data entry) const
overridevirtual

Validate item range: ensure the datatype falls within the allowed range.

Reimplemented from Parsnip::RangeSchema< long >.


The documentation for this class was generated from the following files: