KnowledgeImporter

Struct KnowledgeImporter 

Source
pub struct KnowledgeImporter;
Expand description

Knowledge importer for parsing Knowledge Base article YAML files

Implementations§

Source§

impl KnowledgeImporter

Source

pub fn new() -> Self

Create a new Knowledge importer instance

Source

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

Import a knowledge article from YAML content

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

§Arguments
  • yaml_content - Knowledge article YAML content as a string
§Returns

A KnowledgeArticle parsed from the YAML content

§Example
use data_modelling_core::import::knowledge::KnowledgeImporter;

let importer = KnowledgeImporter::new();
let yaml = r#"
id: 660e8400-e29b-41d4-a716-446655440000
number: 1
title: "Data Classification Guide"
articleType: guide
status: published
summary: "This guide explains data classification."
content: "Data classification is essential for governance."
authors:
  - "data-governance@example.com"
createdAt: "2024-01-15T10:00:00Z"
updatedAt: "2024-01-15T10:00:00Z"
"#;
let article = importer.import(yaml).unwrap();
assert_eq!(article.title, "Data Classification Guide");
Source

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

Import a knowledge article without schema validation

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

§Arguments
  • yaml_content - Knowledge article YAML content as a string
§Returns

A KnowledgeArticle parsed from the YAML content

Source

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

Import a knowledge index from YAML content

§Arguments
  • yaml_content - Knowledge index YAML content (knowledge.yaml)
§Returns

A KnowledgeIndex parsed from the YAML content

§Example
use data_modelling_core::import::knowledge::KnowledgeImporter;

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

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

Import multiple knowledge articles from a directory

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

§Arguments
  • dir_path - Path to the directory containing knowledge article files
§Returns

A vector of parsed KnowledgeArticle objects and any import errors

Source

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

Import articles filtered by domain

§Arguments
  • dir_path - Path to the directory containing knowledge article files
  • domain - Domain to filter by
§Returns

A vector of parsed KnowledgeArticle objects for the specified domain

Trait Implementations§

Source§

impl Default for KnowledgeImporter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more