Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::timeline::FieldSchema Struct Reference

Public field metadata for one registered schema type. More...

#include <schema_registry.hpp>

Public Member Functions

 FieldSchema ()=default
 Constructs an empty, invalid field descriptor for aggregate assembly.
 FieldSchema (std::string field_name, SchemaValueKind value_kind, bool is_required=true, std::string reference={})
 Constructs field metadata and takes ownership of its names.

Public Attributes

std::string name
SchemaValueKind kind = SchemaValueKind::String
bool required = true
std::string referenced_type

Detailed Description

Public field metadata for one registered schema type.

Constructor & Destructor Documentation

◆ FieldSchema() [1/2]

pulp::timeline::FieldSchema::FieldSchema ( )
default

Constructs an empty, invalid field descriptor for aggregate assembly.

◆ FieldSchema() [2/2]

pulp::timeline::FieldSchema::FieldSchema ( std::string field_name,
SchemaValueKind value_kind,
bool is_required = true,
std::string reference = {} )
inline

Constructs field metadata and takes ownership of its names.

Member Data Documentation

◆ kind

SchemaValueKind pulp::timeline::FieldSchema::kind = SchemaValueKind::String

◆ name

std::string pulp::timeline::FieldSchema::name

◆ referenced_type

std::string pulp::timeline::FieldSchema::referenced_type

◆ required

bool pulp::timeline::FieldSchema::required = true

The documentation for this struct was generated from the following file: