OpenE2K
/
libc-rs
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
4,245 Commits 2 Branches 0 Tags 10 MiB
Rust 98%
Shell 1%
Dockerfile 0.7%
CSS 0.3%
Go to file
Yuki Okushi 7da9413423 Replace all mentions about Pipelines with GHA 2021-01-28 18:29:32 +09:00
.github Skip CI for some MIPS targets 2021-01-07 11:53:54 +09:00
ci Replace all mentions about Pipelines with GHA 2021-01-28 18:29:32 +09:00
libc-test Add preadv and pwritev for macOS 2021-01-21 16:26:32 +01:00
src Auto merge of #2042 - pfmooney:illumos-portnotify, r=JohnTitor 2021-01-27 03:18:36 +00:00
tests Run 'cargo fmt' 2019-10-29 09:51:44 -04:00
.cirrus.yml Update to FreeBSD 12.2 2020-10-31 12:36:34 +09:00
.gitignore Ignore the style executable used for testing 2019-02-02 16:32:00 -08:00
CONTRIBUTING.md Document the policy about breaking change 2020-12-07 08:56:12 +09:00
Cargo.toml Bump to 0.2.83 2021-01-18 15:55:29 +00:00
LICENSE-APACHE Initial commit 2015-01-13 08:22:00 -08:00
LICENSE-MIT Update license year 2020-04-12 03:13:36 +09:00
README.md Replace all mentions about Pipelines with GHA 2021-01-28 18:29:32 +09:00
build.rs Add DevkitPPC support 2020-08-05 08:19:48 +01:00
rustfmt.toml Check style using rustfmt and reformat 2019-02-07 11:13:38 +01:00
triagebot.toml Allow contributors to label issues via rustbot 2020-10-16 02:24:57 +09:00

README.md

libc - Raw FFI bindings to platforms' system libraries

GHA Status Cirrus CI Status Latest Version Documentation License

libc provides all of the definitions necessary to easily interoperate with C code (or "C-like" code) on each of the platforms that Rust supports. This includes type definitions (e.g. c_int), constants (e.g. EINVAL) as well as function headers (e.g. malloc).

This crate exports all underlying platform types, functions, and constants under the crate root, so all items are accessible as libc::foo. The types and values of all the exported APIs match the platform that libc is compiled for.

More detailed information about the design of this library can be found in its associated RFC.

Usage

Add the following to your Cargo.toml:

[dependencies]
libc = "0.2"

Features

  • std: by default libc links to the standard library. Disable this feature to remove this dependency and be able to use libc in #![no_std] crates.

  • extra_traits: all structs implemented in libc are Copy and Clone. This feature derives Debug, Eq, Hash, and PartialEq.

  • const-extern-fn: Changes some extern fns into const extern fns. This feature requires a nightly rustc.

  • deprecated: use_std is deprecated, and is equivalent to std.

Rust version support

The minimum supported Rust toolchain version is Rust 1.13.0 . APIs requiring newer Rust features are only available on newer Rust toolchains:

Feature Version
union 1.19.0
const mem::size_of 1.24.0
repr(align) 1.25.0
extra_traits 1.25.0
core::ffi::c_void 1.30.0
repr(packed(N)) 1.33.0
cfg(target_vendor) 1.33.0

Platform support

Platform-specific documentation (master branch).

See ci/build.sh for the platforms on which libc is guaranteed to build for each Rust toolchain. The test-matrix at GitHub Actions and Cirrus CI show the platforms in which libc tests are run.

License

This project is licensed under either of

at your option.

Contributing

We welcome all people who want to contribute. Please see the contributing instructions for more information.

Contributions in any form (issues, pull requests, etc.) to this project must adhere to Rust's Code of Conduct.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in libc by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.