3 unstable releases

new 0.2.0-alpha.1 Nov 22, 2021
0.1.6 Nov 19, 2021

#91 in macOS and iOS APIs

MIT license

321 lines


Latest version License Documentation Apple CI GNUStep CI

Apple's C language extension of blocks in Rust.

For more information on the specifics of the block implementation, see Clang's documentation: http://clang.llvm.org/docs/Block-ABI-Apple.html

Invoking blocks

The Block struct is used for invoking blocks from Objective-C. For example, consider this Objective-C function:

int32_t sum(int32_t (^block)(int32_t, int32_t)) {
    return block(5, 8);

We could write it in Rust as the following:

use block2::Block;
unsafe fn sum(block: &Block<(i32, i32), i32>) -> i32 {
    block.call((5, 8))

Note the extra parentheses in the call method, since the arguments must be passed as a tuple.

Creating blocks

Creating a block to pass to Objective-C can be done with the ConcreteBlock struct. For example, to create a block that adds two i32s, we could write:

use block2::ConcreteBlock;
let block = ConcreteBlock::new(|a: i32, b: i32| a + b);
let block = block.copy();
assert!(unsafe { block.call((5, 8)) } == 13);

It is important to copy your block to the heap (with the copy method) before passing it to Objective-C; this is because our ConcreteBlock is only meant to be copied once, and we can enforce this in Rust, but if Objective-C code were to copy it twice we could have a double free.