spicedb-embedded-sys 0.7.0

FFI and native library for SpiceDB C shared library (builds from Go or downloads prebuilt)
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

//! FFI bindings to the SpiceDB C shared library (built from Go or downloaded per target).
//!
//! Provides an in-memory server and raw C functions that take in marshalled gRPC requests and
//! return marshalled responses or error strings.

mod instance;
mod memory;

pub use instance::{dispose, start};
pub use memory::{RpcError, RpcResult};

pub mod memory_transport {
    //! Safe, typed wrappers for memory-transport RPCs (marshall/unmarshall in this crate).
    pub use crate::memory::{
        RpcError, RpcResult, check_bulk_permissions, check_permission, delete_relationships,
        expand_permission_tree, read_schema, write_relationships, write_schema,
    };
}

use std::os::raw::{c_char, c_int, c_uchar, c_ulonglong};

#[link(name = "spicedb")]
unsafe extern "C" {
    pub(crate) fn spicedb_start(options_json: *const c_char) -> *mut c_char;
    pub(crate) fn spicedb_dispose(handle: c_ulonglong) -> *mut c_char;
    pub(crate) fn spicedb_free(ptr: *mut c_char);

    /// Frees a byte buffer returned by RPC FFI functions.
    pub(crate) fn spicedb_free_bytes(ptr: *mut std::ffi::c_void);

    /// Invokes PermissionsService.CheckPermission. Request/response are marshalled protobuf (authzed.api.v1).
    /// On success: `*out_response_bytes` and `*out_response_len` are set; caller frees `*out_response_bytes` with `spicedb_free_bytes`.
    /// On error: `*out_response_bytes` is NULL, `*out_error` is set; caller frees `*out_error` with `spicedb_free`.
    pub(crate) fn spicedb_permissions_check_permission(
        handle: c_ulonglong,
        request_bytes: *const c_uchar,
        request_len: c_int,
        out_response_bytes: *mut *mut c_uchar,
        out_response_len: *mut c_int,
        out_error: *mut *mut c_char,
    );

    /// Invokes PermissionsService.WriteRelationships. Same ABI as other RPC FFI functions.
    pub(crate) fn spicedb_permissions_write_relationships(
        handle: c_ulonglong,
        request_bytes: *const c_uchar,
        request_len: c_int,
        out_response_bytes: *mut *mut c_uchar,
        out_response_len: *mut c_int,
        out_error: *mut *mut c_char,
    );

    /// Invokes SchemaService.WriteSchema. Same ABI as other RPC FFI functions.
    pub(crate) fn spicedb_schema_write_schema(
        handle: c_ulonglong,
        request_bytes: *const c_uchar,
        request_len: c_int,
        out_response_bytes: *mut *mut c_uchar,
        out_response_len: *mut c_int,
        out_error: *mut *mut c_char,
    );

    pub(crate) fn spicedb_permissions_delete_relationships(
        handle: c_ulonglong,
        request_bytes: *const c_uchar,
        request_len: c_int,
        out_response_bytes: *mut *mut c_uchar,
        out_response_len: *mut c_int,
        out_error: *mut *mut c_char,
    );

    pub(crate) fn spicedb_permissions_check_bulk_permissions(
        handle: c_ulonglong,
        request_bytes: *const c_uchar,
        request_len: c_int,
        out_response_bytes: *mut *mut c_uchar,
        out_response_len: *mut c_int,
        out_error: *mut *mut c_char,
    );

    pub(crate) fn spicedb_permissions_expand_permission_tree(
        handle: c_ulonglong,
        request_bytes: *const c_uchar,
        request_len: c_int,
        out_response_bytes: *mut *mut c_uchar,
        out_response_len: *mut c_int,
        out_error: *mut *mut c_char,
    );

    pub(crate) fn spicedb_schema_read_schema(
        handle: c_ulonglong,
        request_bytes: *const c_uchar,
        request_len: c_int,
        out_response_bytes: *mut *mut c_uchar,
        out_response_len: *mut c_int,
        out_error: *mut *mut c_char,
    );
}