Struct SchemaDefinition 

pub struct SchemaDefinition {
    pub name: String,
    pub description: Option<String>,
    pub fields: Vec<FieldDefinition>,
    pub relationships: HashMap<String, Relationship>,
    pub metadata: HashMap<String, Value>,
}

Schema definition for data generation

Fields

name: String

Schema name

description: Option<String>

Schema description

fields: Vec<FieldDefinition>

Field definitions

relationships: HashMap<String, Relationship>

Relationships to other schemas

metadata: HashMap<String, Value>

Additional metadata

Implementations

impl SchemaDefinition

pub fn new(name: String) -> Self

Create a new schema definition

pub fn with_field(self, field: FieldDefinition) -> Self

Add a field to the schema

pub fn with_fields(self, fields: Vec<FieldDefinition>) -> Self

Add multiple fields to the schema

pub fn with_description(self, description: String) -> Self

Set description

pub fn with_relationship(self, name: String, relationship: Relationship) -> Self

Add a relationship

pub fn with_metadata(self, key: String, value: Value) -> Self

Add metadata

pub fn generate_row(&self, faker: &mut EnhancedFaker) -> Result<Value>

Generate a single row of data

pub fn get_field(&self, name: &str) -> Option<&FieldDefinition>

Get field by name

pub fn from_json_schema(json_schema: &Value) -> Result<Self>

Create schema from JSON Schema

pub fn from_openapi_spec(openapi_spec: &Value) -> Result<Self>

Create schema from OpenAPI spec

Trait Implementations

impl Clone for SchemaDefinition

fn clone(&self) -> SchemaDefinition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SchemaDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SchemaDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SchemaDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.