# ohos-rs

**Repository Path**: ohos-rs/ohos-rs

## Basic Information

- **Project Name**: ohos-rs
- **Description**: A framework for building compiled OpenHarmony SDK in Rust via Node-API(Forked from napi-rs)
- **Primary Language**: Rust
- **License**: MIT
- **Default Branch**: ohos
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 11
- **Forks**: 3
- **Created**: 2023-11-26
- **Last Updated**: 2026-03-13

## Categories & Tags

**Categories**: harmonyos-devtools

**Tags**: None

## README

# ohos-rs

![Crates.io Version](https://img.shields.io/crates/v/napi-ohos) ![Platform](https://img.shields.io/badge/platform-arm64/arm/x86__64-blue) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

> This project is forked from [napi-rs](https://github.com/napi-rs/napi-rs), many thank to [@Brooooooklyn](https://github.com/Brooooooklyn).

## MSRV

1.88.0

## Taste

> You can use [ohrs](https://ohos.rs/en/docs/cli/init.html) to start a new project.

### Define ArkTS function

```rs
use napi_ohos::bindgen_prelude::*;
use napi_derive_ohos::napi;

/// module registration is done by the runtime, no need to explicitly do it now.
#[napi]
pub fn fibonacci(n: u32) -> u32 {
  match n {
    1 | 2 => 1,
    _ => fibonacci(n - 1) + fibonacci(n - 2),
  }
}

/// use `Fn`, `FnMut` or `FnOnce` traits to defined JavaScript callbacks
/// the return type of callbacks can only be `Result`.
#[napi]
pub fn get_cwd<T: Fn(String) -> Result<()>>(callback: T) {
  callback(
    std::env::current_dir()
      .unwrap()
      .to_string_lossy()
      .to_string(),
  )
  .unwrap();
}

/// or, define the callback signature in where clause
#[napi]
pub fn test_callback<T>(callback: T) -> Result<()>
where
  T: Fn(String) -> Result<()>,
{
  callback(std::env::current_dir()?.to_string_lossy().to_string())
}

/// async fn, require `async` feature enabled.
/// [dependencies]
/// napi = {version="2", features=["async"]}
#[napi]
pub async fn read_file_async(path: String) -> Result<Buffer> {
  Ok(tokio::fs::read(path).await?.into())
}
```

## Building

Before build, we must setup some environments. You can follow the [document](https://ohos.rs/en/docs/basic/quick-start.html) to setup them.

Then you can use `ohrs` to build it directly.

```sh
ohrs build

# build single arch
ohrs build --arch aarch
```

Finally you can copy the `dist` folder into your OpenHarmony/HarmonyNext project and use it.

## Asynchronous runtime

We use `tokio` as the default asynchronous runtime. But for some simple scenarios, we don't need so complete runtime, and you can try [ohos-ffrt](https://github.com/ohos-rs/ohos-ffrt).

## Discussion

[Feel free to join our WeChat group!](https://github.com/ohos-rs/ohos-rs/wiki/Welcome-to-join-our-WeChat-Group!)

## License

[MIT](https://github.com/ohos-rs/ohos-rs/blob/ohos/LICENSE)