Crate ax_ctor_bare 

ax-ctor-bare

Register constructor functions for Rust at compile time under no_std

English | 中文

Introduction

ax-ctor-bare provides Register constructor functions for Rust at compile time under no_std. 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-ctor-bare was derived from https://github.com/arceos-org/ctor_bare

Quick Start

Installation

Add this crate to your Cargo.toml:

[dependencies]
ax-ctor-bare = "0.4.1"

Run Check and Test

# Enter the crate directory
cd components/ctor_bare/ctor_bare

# 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_ctor_bare as _;

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

Documentation

Generate and view API documentation:

cargo doc --no-deps --open

Online documentation: docs.rs/ax-ctor-bare

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.

Functions

call_ctors

Invoke all constructor functions registered by the register_ctor attribute.

Attribute Macros

register_ctor

Register a constructor function to be called before main.