Skip to main content

Crate oak_testing

Crate oak_testing 

Source
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:

  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.

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.