c-closures 0.3.1

THIS CRATE IS DEPRECATED, you now only need c-closures-build. General purpose way for Rust closures to cross an FFI boundary into C/C++. Use with `c-closures-build`.
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

#ifndef RUST_CLOSURES_H
#define RUST_CLOSURES_H

/// A general purpose closure type defined in C code which can be created in Rust.
typedef struct Closure {
  /// Directions to call the contained closure
  void *(*function)(void * data, void * const arg);
  /// Rust user data for this closure.
  void * data;
  /// The data pointer may require personalized delete instructions, we can
  /// access those here.
  void (*delete_data)(void *data);
  /// The value returned by this function may require personalized delete
  /// instructions, we can access those here.
  void (*delete_ret)(void *ret);
} Closure;

/// Calls the inner code. The return value of this may have come from
/// Rust, meaning you can not free it. However it must be freed. When
/// you're done with the return value, pass it back to Rust with
/// `closure_release_return_value` so that the memory isn't leaked. If you won't be
/// using the return value, instead call `closure_call_with_no_return`.
void *closure_call(Closure * const self, void * const arg);

/// Cleans up the value returned by calling this Closure. Do not attempt
/// to free the returned pointer yourself.
void closure_release_return_value(Closure * const self, void *ret);

/// Calls the inner code and cleans up the returned value, if any.
void closure_call_with_no_return(Closure * const self, void * const arg);

/// Release data associated with this closure, must be called when done with
/// Closure to avoid memory leaking.
void closure_release(Closure * const self);
#endif