Crate ax_config_macros 

ax-config-macros

Procedural macros for converting TOML format configurations to Rust constant definitions

English | 中文

Introduction

ax-config-macros provides Procedural macros for converting TOML format configurations to Rust constant definitions. It is maintained as part of the TGOSKits component set and is intended for Rust projects that integrate with ArceOS, AxVisor, or related low-level systems software.

ax-config-macros was derived from https://github.com/arceos-org/axconfig-gen

Quick Start

Installation

Add this crate to your Cargo.toml:

[dependencies]
ax-config-macros = "0.4.1"

Run Check and Test

# Enter the crate directory
cd components/axconfig-gen/axconfig-macros

# Format code
cargo fmt --all

# Run clippy
cargo clippy --all-targets --all-features

# Run tests
cargo test --all-features

# Build documentation
cargo doc --no-deps

Integration

Example

use ax_config_macros as _;

fn main() {
    // Integrate `ax-config-macros` into your project here.
}

Documentation

Generate and view API documentation:

cargo doc --no-deps --open

Online documentation: docs.rs/ax-config-macros

Contributing

1. Fork the repository and create a branch
2. Run local format and checks
3. Run local tests relevant to this crate
4. Submit a PR and ensure CI passes

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.

Macros

include_configs

Includes a TOML format config file and expands it into Rust code.

parse_configs

Parses TOML config content and expands it into Rust code.