Crate oak_voml 

🛠️ Developer Guide

Voml support for the Oak language framework.

This directory contains the core logic implementation of the project. Below are instructions for a quick start.

🚦 Quick Start

Core API Usage

// Example: Basic calling workflow
fn main() {
    // 1. Initialization
    // 2. Execute core logic
    // 3. Handle returned results
}

🔍 Module Description

• lib.rs: Exports public interfaces and core traits.
• parser/ (if exists): Implements specific syntax parsing logic.
• ast/ (if exists): Defines the syntax tree structure.

🏗️ Architecture Design

The project follows the general architectural specifications of the Oak ecosystem, emphasizing:

1. Immutability: Uses the Green/Red Tree structure to ensure efficient sharing of syntax trees.
2. Fault Tolerance: Core logic is highly inclusive of erroneous input.
3. Scalability: Convenient for downstream tools to perform secondary development.

Re-exports

pub use crate::ast::VRoot;

pub use crate::builder::VomlBuilder;

pub use crate::language::VomlLanguage;

pub use crate::lexer::VomlLexer;

pub use crate::parser::VomlParser;

pub use crate::lsp::VomlLanguageService;

pub use lexer::token_type::VomlTokenType;

pub use parser::element_type::VomlElementType;

Modules

ast

AST module.

builder

Builder module. Voml AST builder.

language

Type definitions module. Language configuration module.

lexer

Lexer module.

lsp

LSP module.

parser

Parser module.

Traits

ElementType

Syntax module. A trait for types that represent an element’s kind in a syntax tree.

TokenType

Syntax module. A trait for types that represent a token’s kind in a specific language.

Functions

parse

Parses a Voml string into a VRoot.