Struct SketchImporter 

pub struct SketchImporter;

Sketch importer for parsing Excalidraw sketch YAML files

Implementations

impl SketchImporter

pub fn new() -> SketchImporter

Create a new Sketch importer instance

pub fn import(&self, yaml_content: &str) -> Result<Sketch, ImportError>

Import a sketch from YAML content

Optionally validates against the JSON schema if the schema-validation feature is enabled.

Arguments

• yaml_content - Sketch YAML content as a string

Returns

A Sketch parsed from the YAML content

Example

use data_modelling_core::import::sketch::SketchImporter;

let importer = SketchImporter::new();
let yaml = r#"
id: 770e8400-e29b-41d4-a716-446655440001
number: 1
title: "Architecture Diagram"
sketchType: architecture
status: published
excalidrawData: "{}"
createdAt: "2024-01-15T10:00:00Z"
updatedAt: "2024-01-15T10:00:00Z"
"#;
let sketch = importer.import(yaml).unwrap();
assert_eq!(sketch.title, "Architecture Diagram");

pub fn import_without_validation( &self, yaml_content: &str, ) -> Result<Sketch, ImportError>

Import a sketch without schema validation

Use this when you want to skip schema validation for performance or when importing from a trusted source.

Arguments

• yaml_content - Sketch YAML content as a string

Returns

A Sketch parsed from the YAML content

pub fn import_index( &self, yaml_content: &str, ) -> Result<SketchIndex, ImportError>

Import a sketch index from YAML content

Arguments

• yaml_content - Sketch index YAML content (sketches.yaml)

Returns

A SketchIndex parsed from the YAML content

Example

use data_modelling_core::import::sketch::SketchImporter;

let importer = SketchImporter::new();
let yaml = r#"
schemaVersion: "1.0"
sketches: []
nextNumber: 1
"#;
let index = importer.import_index(yaml).unwrap();
assert_eq!(index.next_number, 1);

pub fn import_from_directory( &self, dir_path: &Path, ) -> Result<(Vec<Sketch>, Vec<ImportError>), ImportError>

Import multiple sketches from a directory

Loads all .sketch.yaml files from the specified directory.

Arguments

• dir_path - Path to the directory containing sketch files

Returns

A vector of parsed Sketch objects and any import errors

pub fn import_by_domain( &self, dir_path: &Path, domain: &str, ) -> Result<(Vec<Sketch>, Vec<ImportError>), ImportError>

Import sketches filtered by domain

Arguments

• dir_path - Path to the directory containing sketch files
• domain - Domain to filter by

Returns

A vector of parsed Sketch objects for the specified domain

Trait Implementations

impl Default for SketchImporter

fn default() -> SketchImporter

Returns the “default value” for a type.