Enum SkillFormat 

pub enum SkillFormat {
    Markdown,
    Json,
}

Supported import and export formats for skill documents.

MentisDB stores every skill as a SkillVersionContent::Full raw string in the format it was uploaded in. The registry can round-trip any skill through either format: upload in Markdown, read back as JSON (or vice-versa) via SkillRegistry::read_skill.

Examples

use mentisdb::SkillFormat;
use std::str::FromStr;

// Display gives the canonical lowercase name.
assert_eq!(SkillFormat::Markdown.to_string(), "markdown");
assert_eq!(SkillFormat::Json.to_string(), "json");

// Both "md" and "markdown" parse as Markdown.
assert_eq!("md".parse::<SkillFormat>().unwrap(), SkillFormat::Markdown);
assert_eq!("json".parse::<SkillFormat>().unwrap(), SkillFormat::Json);

// Unknown strings return an error.
assert!("xml".parse::<SkillFormat>().is_err());

Variants

Markdown

Markdown skill document with optional YAML-like frontmatter.

The Markdown parser recognises an optional --- … --- frontmatter block at the top of the file that may carry name, description, tags, triggers, and warnings key-value pairs. Everything after the frontmatter block is parsed into SkillSections by heading level.

Json

JSON representation of the structured SkillDocument object.

The JSON format is a direct serde_json serialisation of SkillDocument. It is useful for programmatic consumption or when the skill content is already available as a structured object rather than freeform Markdown.

Implementations

impl SkillFormat

pub fn as_str(self) -> &'static str

Return the stable lowercase name of this format.

Trait Implementations

impl Clone for SkillFormat

fn clone(&self) -> SkillFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SkillFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SkillFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SkillFormat

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

Formats the value using the given formatter.

impl FromStr for SkillFormat

type Err = String

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for SkillFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SkillFormat

fn eq(&self, other: &SkillFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SkillFormat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SkillFormat

impl Eq for SkillFormat

impl StructuralPartialEq for SkillFormat