[go: up one dir, main page]

dispatch2 0.3.0

Bindings and wrappers for Apple's Grand Central Dispatch (GCD)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

//! # Apple's Dispatch (Grand Central Dispatch)
//!
//! This crate provides a safe and sound interface to Apple's Grand Central
//! dispatch.
//!
//! See [Apple's documentation](https://developer.apple.com/documentation/dispatch)
//! and [the source code for libdispatch](https://github.com/swiftlang/swift-corelibs-libdispatch)
//! for more details.
//!
//! ## Example
//!
//! ```
//! use dispatch2::{DispatchQueue, DispatchQueueAttr};
//!
//! let queue = DispatchQueue::new("example_queue", DispatchQueueAttr::SERIAL);
//! queue.exec_async(|| println!("Hello"));
//! queue.exec_sync(|| println!("World"));
//! ```
#![no_std]
#![allow(unreachable_patterns)]
#![warn(missing_docs)]
#![warn(missing_debug_implementations)]
#![warn(clippy::undocumented_unsafe_blocks)]
#![warn(clippy::missing_safety_doc)]
// Update in Cargo.toml as well.
#![doc(html_root_url = "https://docs.rs/dispatch2/0.3.0")]

#[cfg(not(feature = "alloc"))]
compile_error!("The `alloc` feature currently must be enabled.");

extern crate alloc;

#[cfg(feature = "std")]
extern crate std;

#[macro_use]
mod macros;

use core::cell::UnsafeCell;
use core::marker::{PhantomData, PhantomPinned};

mod data;
#[allow(clippy::undocumented_unsafe_blocks, unreachable_pub)]
mod generated;
mod group;
mod io;
#[cfg(feature = "objc2")]
mod main_thread_bound;
mod object;
mod once;
mod queue;
mod retained;
mod semaphore;
mod source;
mod time;
mod utils;
mod workloop;

/// Wait error.
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
#[non_exhaustive]
pub enum WaitError {
    /// The given timeout value will result in an overflow when converting to dispatch time.
    TimeOverflow,
    /// The operation timed out.
    Timeout,
}

pub use self::data::DispatchData;
#[cfg(feature = "block2")]
pub use self::generated::{
    _dispatch_data_destructor_free, _dispatch_data_destructor_munmap, dispatch_block_cancel,
    dispatch_block_create, dispatch_block_create_with_qos_class, dispatch_block_notify,
    dispatch_block_perform, dispatch_block_t, dispatch_block_testcancel, dispatch_block_wait,
    dispatch_data_applier_t, dispatch_io_handler_t, dispatch_read, dispatch_write,
};
pub use self::generated::{
    dispatch_allow_send_signals, dispatch_fd_t, dispatch_get_specific, dispatch_once_t,
    DispatchAutoReleaseFrequency, _dispatch_source_type_data_add, _dispatch_source_type_data_or,
    _dispatch_source_type_data_replace, _dispatch_source_type_mach_recv,
    _dispatch_source_type_mach_send, _dispatch_source_type_memorypressure,
    _dispatch_source_type_proc, _dispatch_source_type_read, _dispatch_source_type_signal,
    _dispatch_source_type_timer, _dispatch_source_type_vnode, _dispatch_source_type_write,
    DISPATCH_API_VERSION,
};
pub use self::group::{DispatchGroup, DispatchGroupGuard};
pub use self::io::{
    DispatchIO, DispatchIOCloseFlags, DispatchIOIntervalFlags, DispatchIOStreamType,
};
#[cfg(feature = "objc2")]
pub use self::main_thread_bound::{run_on_main, MainThreadBound};
pub(crate) use self::object::dispatch_object_s;
pub use self::object::{
    DispatchObject, DispatchQoS, QualityOfServiceClassFloorError, QOS_MIN_RELATIVE_PRIORITY,
};
pub use self::once::DispatchOnce;
pub use self::queue::{
    dispatch_main, DispatchQueue, DispatchQueueAttr, DispatchQueueGlobalPriority,
    GlobalQueueIdentifier, QueueAfterError,
};
pub use self::retained::DispatchRetained;
pub use self::semaphore::{DispatchSemaphore, DispatchSemaphoreGuard};
pub use self::source::{
    dispatch_source_mach_recv_flags_t, dispatch_source_mach_send_flags_t,
    dispatch_source_memorypressure_flags_t, dispatch_source_proc_flags_t,
    dispatch_source_timer_flags_t, dispatch_source_type_s, dispatch_source_type_t,
    dispatch_source_vnode_flags_t, DispatchSource,
};
pub use self::time::DispatchTime;
pub use self::workloop::DispatchWorkloop;

// Helper type
type OpaqueData = UnsafeCell<PhantomData<(*const UnsafeCell<()>, PhantomPinned)>>;

/// Deprecated alias for [`DispatchGroup`].
#[deprecated = "renamed to DispatchGroup"]
pub type Group = DispatchGroup;

/// Deprecated alias for [`DispatchOnce`].
#[deprecated = "renamed to DispatchOnce"]
pub type Once = DispatchOnce;

/// Deprecated alias for [`DispatchQueue`].
#[deprecated = "renamed to DispatchQueue"]
pub type Queue = DispatchQueue;

/// Deprecated alias for [`DispatchSemaphore`].
#[deprecated = "renamed to DispatchSemaphore"]
pub type Semaphore = DispatchSemaphore;

/// Deprecated alias for [`DispatchWorkloop`].
#[deprecated = "renamed to DispatchWorkloop"]
pub type WorkloopQueue = DispatchWorkloop;

#[cfg_attr(target_vendor = "apple", link(name = "System", kind = "dylib"))]
#[cfg_attr(not(target_vendor = "apple"), link(name = "dispatch", kind = "dylib"))]
extern "C" {}

/// The prototype of functions submitted to dispatch queues.
///
/// This is deliberately `extern "C"`, since libdispatch doesn't support
/// unwinding in handler functions, and this gives us better error messages
/// if that does happen.
#[allow(non_camel_case_types)]
pub type dispatch_function_t = extern "C" fn(*mut core::ffi::c_void);