• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# libc - 提供 C 标准库的rust侧FFI
2
3[![GHA Status]][GitHub Actions] [![Cirrus CI Status]][Cirrus CI] [![Latest Version]][crates.io] [![Documentation]][docs.rs] ![License]
4
5## 引入背景
6`libc`提供了所有必要的定义,以便在Rust轻松与C
7代码(或 "类C "代码)在Rust支持的平台上的调用。这包括
8包括类型定义(如`c_int`),常量(如`EINVAL`)以及
9函数(例如:`malloc')。
10
11libc将各类平台中C库的类型、函数和常量导出在根目录下,所以所有项目都可以作为`libc::foo'访问这些API。
12所有导出的API的类型和值都与 libc 编译的平台一致。
13
14关于这个库的设计,更详细的信息可以在这里找到
15[associated RFC][rfc].
16
17[rfc]: https://github.com/rust-lang/rfcs/blob/master/text/1291-promote-libc.md
18
19## 用法指导
20### 使用Openharmony编译框架
21在你的"BUILD.gn"中使用deps字段添加对libc crate的依赖,例如:
22
23```BUILD.gn
24ohos_rust_shared_library("foo") {
25  source = [ "src/lib.rs" ]
26  deps = [ "//third_party/rust/crates/libc:lib" ]
27}
28```
29
30### 使用Cargo
31在你的 "Cargo.toml "中添加以下内容:
32
33```toml
34[dependencies]
35libc = "0.2"
36```
37
38## 特点
39
40* `std`:默认情况下,`libc`链接到标准库。禁用这个
41  来消除这一依赖关系,并能够在`#![no_std]`中使用`libc`。
42  crates。
43
44* `extra_traits`: `libc`中实现的所有`结构'都是`Copy`和`Clone`。
45  这个特性衍生出了`Debug`、`Eq`、`Hash`和`PartialEq`。
46
47* `const-extern-fn`: 将一些`extern fn`s改为`const extern fn`s。
48  如果你使用Rust >= 1.62,这个功能是隐式启用的。
49  否则,它需要一个夜间的Rustc。
50
51**已废弃**: `use_std`已被废弃,等同于`std`。
52
53## Rust版本支持
54
55目前支持的最小Rust工具链版本是**Rust 1.13.0**。(libc 目前没有任何计划关于改变最小支持的支持的 Rust 版本)。需要较新的 Rust 特性的 API 只在较新的 Rust 工具链上可用:
56
57| Feature              | Version |
58|----------------------|---------|
59| `union`              |  1.19.0 |
60| `const mem::size_of` |  1.24.0 |
61| `repr(align)`        |  1.25.0 |
62| `extra_traits`       |  1.25.0 |
63| `core::ffi::c_void`  |  1.30.0 |
64| `repr(packed(N))`    |  1.33.0 |
65| `cfg(target_vendor)` |  1.33.0 |
66| `const-extern-fn`    |  1.62.0 |
67
68## 平台支持
69
70[特定平台文档(master分支)][docs.master]。
71
72见[`ci/build.sh`](https://github.com/rust-lang/libc/blob/master/ci/build.sh)
73关于每个Rust工具链的`libc`保证可以在哪些平台上构建。
74工具链的平台。在[GitHub Actions]和[Cirrus CI]中的测试矩阵显示了
75`libc`测试运行的平台。
76<div class="platform_docs"></div>
77
78## 许可证
79
80本项目的授权范围是
81
82* [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
83  ([LICENSE-APACHE](https://github.com/rust-lang/libc/blob/master/LICENSE-APACHE))
84
85* [MIT License](https://opensource.org/licenses/MIT)
86  ([LICENSE-MIT](https://github.com/rust-lang/libc/blob/master/LICENSE-MIT))
87
88[GitHub Actions]: https://github.com/rust-lang/libc/actions
89[GHA Status]: https://github.com/rust-lang/libc/workflows/CI/badge.svg
90[Cirrus CI]: https://cirrus-ci.com/github/rust-lang/libc
91[Cirrus CI Status]: https://api.cirrus-ci.com/github/rust-lang/libc.svg
92[crates.io]: https://crates.io/crates/libc
93[Latest Version]: https://img.shields.io/crates/v/libc.svg
94[Documentation]: https://docs.rs/libc/badge.svg
95[docs.rs]: https://docs.rs/libc
96[License]: https://img.shields.io/crates/l/libc.svg
97[docs.master]: https://rust-lang.github.io/libc/#platform-specific-documentation
98
99## 开发者贡献
100
101在使用该工具的过程中有任何问题欢迎开发者在社区issue中反馈。
102
103<br>