#sys #apple #macos #bindgen

sys apple-sys

The auto-managed -sys crate for Apple platforms using bindgen directly from build environment

5 unstable releases

0.2.0 Jan 30, 2023
0.1.2 Jul 23, 2022
0.1.1 Jul 22, 2022
0.1.0 Jul 21, 2022
0.0.1 Jul 21, 2022

#30 in macOS and iOS APIs

Download history 21/week @ 2022-12-06 16/week @ 2022-12-13 17/week @ 2022-12-20 9/week @ 2022-12-27 7/week @ 2023-01-03 13/week @ 2023-01-10 14/week @ 2023-01-17 51/week @ 2023-01-24 37/week @ 2023-01-31 21/week @ 2023-02-07 44/week @ 2023-02-14 27/week @ 2023-02-21 10/week @ 2023-02-28 24/week @ 2023-03-07 16/week @ 2023-03-14 17/week @ 2023-03-21

68 downloads per month
Used in 2 crates

BSD-2-Clause

110KB
2.5K SLoC

apple-sys

Apple platforms have a rather monotonous programming environment compared to other platforms. On several development machines, we will dependably obtain the same bindgen result. Then why not simply having bindgen configurations for the frameworks?

How to use?

To add CoreFoundation and IOKit, try to run:

$ cargo add apple-sys --features=CoreFoundation,IOKit

If you are using older version of cargo, try to add to Cargo.toml:

apple-sys = { version = "*", features=["CoreFoundation", "IOKit"] }

The names of the features and the frameworks are same. To see the full list, check the project’s features in the Cargo.toml file.

The feature names are the module names. Everything is single-depth. There are no nested modules.

use apple_sys::{CoreFoundation, IOKit};

// CoreFoundation::<any name>
// IOKit::<any name>

apple-bindgen

The bindgen tool is installable and generating the same result to apple-sys crates. To create a new -sys project, starting with apple-bindgen result will be a convenient way.

Install:

$ cargo install apple-bindgen

To generate CoreFoundation bindings,

$ apple-bindgen CoreFoundation --sdk macosx

To generate UIKit bindings for iOS,

$ apple-bindgen UIKit --sdk iphoneos

Why apple-sys?

apple-sys contains auto-generated bindgen modules for Apple platforms. As long as we use the same versions of SDKs and bindgen, the result will be reproducible.

Why not apple-sys?

Continually using the same SDKs doesn't sound realistic. I agree. Don’t trust apple-sys. Use the managed versions as best you can. For CoreFoundation, for instance, use core-foundation-sys.

Then why do I use apple-sys? I created apple-sys for minor and unmanaged frameworks. apple-sys will be the last fallback.

Contributing

There are no plans for apple-sys to distribute generated or manually changed code. We shall just manage bindgen rules. Look in the project root directory's "bindgen/Bindgen.toml" file.

Dependencies

~0–1.6MB
~35K SLoC