apple-cf 0.6.1

Safe Rust bindings for Apple's shared Core* frameworks (CoreFoundation, CoreMedia, CoreVideo, CoreGraphics, IOSurface, Dispatch).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

//! `apple-cf` — safe, dependency-free Rust bindings for Apple's shared
//! Core* frameworks.
//!
//! This crate is the foundation of the doom-fish macOS Rust suite. It exists
//! so framework-agnostic types like [`cg::CGRect`], [`iosurface::IOSurface`],
//! and [`DispatchQueue`] don't have to be re-vendored by every crate that
//! builds on top of `CMSampleBuffer`/`CVPixelBuffer`/etc.
//!
//! # Modules
//!
//! | Module | Framework | Feature flag |
//! |---|---|---|
//! | [`cf`] | Core Foundation value, collection, locale, formatter, and runtime wrappers | — |
//! | [`cg`] | CoreGraphics value types + bitmap drawing wrappers | `cg` |
//! | [`iosurface`] | `IOSurface` (zero-copy GPU buffers) | `iosurface` |
//! | [`dispatch_queue`] | Grand Central Dispatch | `dispatch` |
//! | [`cm`] | `CoreMedia` time / sample / buffer wrappers | `cm` |
//! | [`cv`] | `CoreVideo` pixel-buffer wrappers | `cv` |
//! | [`utils`] | shared FFI helpers (always on) | — |
//!
//! # Architecture
//!
//! ```text
//! Safe Rust API (CGRect, CGContext, IOSurface, DispatchQueue, ...)
//!     ├── direct Apple framework FFI (src/cg/mod.rs)
//!     └── Swift @_cdecl bridge FFI (src/ffi/mod.rs)
//!             └── swift-bridge/Sources/...
//!                     └── Apple Core* frameworks
//! ```

#![cfg_attr(docsrs, feature(doc_cfg))]

mod error;

pub mod cf;
pub mod ffi;
pub mod utils;

pub use error::CFError;

#[cfg(feature = "cg")]
#[cfg_attr(docsrs, doc(cfg(feature = "cg")))]
pub mod cg;

#[cfg(feature = "iosurface")]
#[cfg_attr(docsrs, doc(cfg(feature = "iosurface")))]
pub mod iosurface;

#[cfg(feature = "dispatch")]
#[cfg_attr(docsrs, doc(cfg(feature = "dispatch")))]
pub mod dispatch_queue;

#[cfg(feature = "cm")]
#[cfg_attr(docsrs, doc(cfg(feature = "cm")))]
pub mod cm;

#[cfg(feature = "cv")]
#[cfg_attr(docsrs, doc(cfg(feature = "cv")))]
pub mod cv;

pub use utils::FourCharCode;

/// Common imports for users of this crate.
pub mod prelude {
    pub use crate::cf::{CFArray, CFString, CFType, CFURL};
    #[cfg(feature = "cg")]
    pub use crate::cg::{CGPoint, CGRect, CGSize};
    #[cfg(feature = "cm")]
    pub use crate::cm::{CMBlockBuffer, CMFormatDescription, CMSampleBuffer, CMTime, CMTimeRange};
    #[cfg(feature = "cv")]
    pub use crate::cv::{
        CVBuffer, CVImageBuffer, CVMetalTextureCache, CVPixelBuffer, CVPixelBufferLockFlags,
    };
    #[cfg(feature = "dispatch")]
    pub use crate::dispatch_queue::{
        DispatchGroup, DispatchQoS, DispatchQueue, DispatchSemaphore, DispatchSource,
    };
    #[cfg(feature = "iosurface")]
    pub use crate::iosurface::{IOSurface, IOSurfaceLockOptions};
    pub use crate::utils::FourCharCode;
}