CoreFoundation-sys

Crates.io	CoreFoundation-sys
lib.rs	CoreFoundation-sys
version	0.1.4
created_at	2015-06-01 16:21:50.840911+00
updated_at	2017-11-12 17:33:12.263299+00
description	FFI bindings for CoreFoundation
homepage	https://github.com/dcuddeback/core-foundation-sys
repository	https://github.com/dcuddeback/core-foundation-sys
max_upload_size
id	2280
size	42,374

David Cuddeback (dcuddeback)

documentation

README

CoreFoundation Rust Bindings

The CoreFoundation-sys package provides declarations and linkage for the CoreFoundation C library on OS X. Following the *-sys package conventions, the CoreFoundation-sys package does not define higher-level abstractions over the native library.

Status

The CoreFoundation-sys crate is a work in progress. It currently exports the most basic types (array, dictionary, string, etc) and functions from CoreFoundation and has been tested only on the x86_64 architecture on OS X.

Usage

Add CoreFoundation-sys as a dependency in Cargo.toml:

[dependencies]
CoreFoundation-sys = "0.1.4"

Import the CoreFoundation_sys crate and use the functions as they're defined in the native CoreFoundation library provided by Apple.

extern crate CoreFoundation_sys as cf;

Contributing

You may find that you need some functionality that is missing from CoreFoundation-sys. If that's the case, please open an issue on Github or send a pull request with the added functionality.

If you plan to submit a pull request, please note the structure of the code. There is one file for each header file in the CoreFoundation framework. For example, src/string.rs contains the definitions from CoreFoundation/CFString.h. The definitions in each file are more or less in the same order that they appear in the matching header file. Each file is then re-exported in the crate root, e.g., pub use string::*.