English | 中文

Introduction

ax-errno provides Generic error code representation. 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-errno was derived from https://github.com/arceos-org/axerrno

Quick Start

Installation

Add this crate to your Cargo.toml:

[dependencies]
ax-errno = "0.4.2"

Run Check and Test

# Enter the crate directory
cd components/axerrno

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

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

Documentation

Generate and view API documentation:

cargo doc --no-deps --open

Online documentation: docs.rs/ax-errno

Contributing

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

License

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

ax-errno 0.4.7