Expand description
ยง๐ ๏ธ Developer Guide
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:
- Immutability: Uses the Green/Red Tree structure to ensure efficient sharing of syntax trees.
- Fault Tolerance: Core logic is highly inclusive of erroneous input.
- Scalability: Convenient for downstream tools to perform secondary development.
Modulesยง
- building
- Testing utilities for tree building. Builder testing utilities for the Oak ecosystem.
- lexing
- Testing utilities for lexing. Lexer testing utilities for the Oak ecosystem.
- parsing
- Testing utilities for parsing. Parser testing utilities for the Oak ecosystem.
Functionsยง
- create_
file - Creates a file and its parent directories.
- json_
from_ path - Reads JSON data from a file path.
- open_
file - Opens a file and returns a file handle.
- source_
from_ path - Reads source text from a file path.