squiid/rust-libc
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
Rust libc fork for squiid.
5783 commits 2 branches 0 tags 18 MiB
Rust 98.4%
Shell 0.8%
Dockerfile 0.6%
CSS 0.2%
Find a file
Josh Triplett 39f779c1df README.md: Clarify (lack of) MSRV policy 
MSRV policy is still being discussed on an ongoing basis in
https://github.com/rust-lang/libs-team/issues/72 . In the interim,
clarify in README that libc doesn't currently have an MSRV policy.
2022-07-26 11:38:58 -07:00
.github Upgrade macOS image to 12 2022-06-21 23:17:59 +09:00
ci style: Format errors so that editors can jump to file/line 2022-07-11 23:37:09 -07:00
libc-test Few socket updates related for Linux. 2022-07-22 12:42:17 +01:00
src Few socket updates related for Linux. 2022-07-22 12:42:17 +01:00
tests Run 'cargo fmt' 2019-10-29 09:51:44 -04:00
.cirrus.yml Remove FreeBSD 11 from CI 2022-05-05 10:12:25 +01:00
.gitignore Ignore the style executable used for testing 2019-02-02 16:32:00 -08:00
build.rs Enable libc_const_extern_fn implicitly from Rust 1.62 2022-06-08 17:42:05 +09:00
Cargo.toml Bump version to 0.2.126 2022-05-15 09:50:53 +03:00
CONTRIBUTING.md Document "Supported target policy" 2022-06-19 11:36:17 +09:00
LICENSE-APACHE Removed Apache License appendix 2022-01-31 18:17:33 +04:00
LICENSE-MIT Update license year 2020-04-12 03:13:36 +09:00
README.md README.md: Clarify (lack of) MSRV policy 2022-07-26 11:38:58 -07:00
rustfmt.toml Relax the line length limit to 100 2021-04-06 09:55:52 +09: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. If you use Rust >= 1.62, this feature is implicitly enabled. Otherwise it requires a nightly rustc.

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

Rust version support

The minimum supported Rust toolchain version is currently Rust 1.13.0. (libc does not currently have any policy regarding changes to the minimum supported Rust version; such policy is a work in progress.) 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
const-extern-fn 1.62.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.