Skip to main content

Crate oak_ini

Crate oak_ini 

Source
Expand description

ยง๐Ÿ› ๏ธ Developer Guide

Ini 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::IniRoot;
pub use crate::builder::IniBuilder;
pub use crate::language::IniLanguage;
pub use crate::lexer::IniLexer;
pub use crate::parser::IniParser;
pub use crate::lsp::highlighter::IniHighlighter;
pub use crate::lsp::IniLanguageService;
pub use crate::mcp::serve_ini_mcp;
pub use lexer::token_type::IniTokenType;
pub use parser::element_type::IniElementType;

Modulesยง

ast
AST module.
builder
Builder module.
language
Type definitions module. Language configuration module.
lexer
Lexer module.
lsp
LSP module.
mcp
MCP module.
parser
Parser module.

Functionsยง

parse
Parses an INI string.