Expand description
ยง๐ ๏ธ Developer Guide
Protobuf 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:
- 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.
Re-exportsยง
pub use crate::ast::ProtobufRoot;pub use crate::builder::ProtobufBuilder;pub use crate::language::ProtobufLanguage;pub use crate::lexer::token_type::ProtobufTokenType;pub use crate::parser::ProtobufParser;pub use crate::lsp::ProtobufLanguageService;pub use parser::element_type::ProtobufElementType;
Modulesยง
- ast
- AST module for Protobuf.
- builder
- Builder module for Protobuf.
- language
- Language configuration for Protobuf.
- lexer
- Lexer for Protobuf.
- lsp
- LSP support for Protobuf.
- mcp
- MCP module for Protobuf.
- parser
- Parser for Protobuf.
Functionsยง
- parse
- Parses a Protobuf string.