Skip to main content

Crate ax_cpumask

Crate ax_cpumask 

Source
Expand description

ax-cpumask

CPU mask library in Rust

Crates.io Docs.rs Rust License

English | 中文

§Introduction

ax-cpumask provides CPU mask library in Rust. 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-cpumask was derived from https://github.com/arceos-org/cpumask

§Quick Start

§Installation

Add this crate to your Cargo.toml:

[dependencies]
ax-cpumask = "0.3.0"

§Run Check and Test

# Enter the crate directory
cd components/cpumask

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

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

§Documentation

Generate and view API documentation:

cargo doc --no-deps --open

Online documentation: docs.rs/ax-cpumask

§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.

Structs§

CpuMask
A compact array of bits which represents a set of physical CPUs, implemented based on bitmaps::Bitmap.
Iter
An iterator over the indices in a cpumask which are true.