cjson-bindings 0.6.4

Safe Rust bindings for the cJSON library - a lightweight JSON parser in C with support for JSON Pointer (RFC6901), JSON Patch (RFC6902), and JSON Merge Patch (RFC7386)
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

/***************************************************************************
 *
 * cJSON FFI BINDING FOR RUST
 * Copyright (C) 2026 Antonio Salsi <passy.linux@zresa.it>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see <https://www.gnu.org/licenses/>.
 *
 ***************************************************************************/

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
#![allow(dead_code)]
#![allow(clashing_extern_declarations)]


use crate::cjson_ffi::{ cJSON };

// ========================
// EXTERN "C" FUNCTION DECLARATIONS
// ========================

unsafe extern "C" {
    // RFC6901: JSON Pointer
    /// Get a pointer to a value in a JSON object using RFC6901 syntax.
    /// Returns NULL if not found or invalid.
    pub fn cJSONUtils_GetPointer(object: *mut cJSON, pointer: *const i8) -> *mut cJSON;

    /// Get a pointer to a value in a JSON object using RFC6901 syntax, case-sensitive.
    pub fn cJSONUtils_GetPointerCaseSensitive(object: *mut cJSON, pointer: *const i8) -> *mut cJSON;

    // RFC6902: JSON Patch
    /// Generate a JSON Patch (RFC6902) to transform 'from' into 'to'.
    /// Modifies both 'from' and 'to' by sorting keys.
    pub fn cJSONUtils_GeneratePatches(from: *mut cJSON, to: *mut cJSON) -> *mut cJSON;

    /// Generate a JSON Patch (RFC6902) to transform 'from' into 'to', case-sensitive.
    pub fn cJSONUtils_GeneratePatchesCaseSensitive(from: *mut cJSON, to: *mut cJSON) -> *mut cJSON;

    /// Add a patch operation to an array.
    pub fn cJSONUtils_AddPatchToArray(array: *mut cJSON, operation: *const i8, path: *const i8, value: *const cJSON);

    /// Apply a JSON Patch (RFC6902) to an object.
    /// Returns 0 on success.
    pub fn cJSONUtils_ApplyPatches(object: *mut cJSON, patches: *const cJSON) -> i32;

    /// Apply a JSON Patch (RFC6902) to an object, case-sensitive.
    pub fn cJSONUtils_ApplyPatchesCaseSensitive(object: *mut cJSON, patches: *const cJSON) -> i32;

    // RFC7386: JSON Merge Patch
    /// Apply a JSON Merge Patch (RFC7386) to 'target'.
    /// Returns new pointer to modified 'target'.
    pub fn cJSONUtils_MergePatch(target: *mut cJSON, patch: *const cJSON) -> *mut cJSON;

    /// Apply a JSON Merge Patch (RFC7386) to 'target', case-sensitive.
    pub fn cJSONUtils_MergePatchCaseSensitive(target: *mut cJSON, patch: *const cJSON) -> *mut cJSON;

    /// Generate a JSON Merge Patch to transform 'from' into 'to'.
    /// Modifies both 'from' and 'to' by sorting keys.
    pub fn cJSONUtils_GenerateMergePatch(from: *mut cJSON, to: *mut cJSON) -> *mut cJSON;

    /// Generate a JSON Merge Patch to transform 'from' into 'to', case-sensitive.
    pub fn cJSONUtils_GenerateMergePatchCaseSensitive(from: *mut cJSON, to: *mut cJSON) -> *mut cJSON;

    // Utility: Find pointer from object to target
    /// Find a JSON Pointer from 'object' to 'target'.
    /// Returns NULL if not found.
    pub fn cJSONUtils_FindPointerFromObjectTo(object: *const cJSON, target: *const cJSON) -> *mut i8;

    // Sort object members alphabetically
    /// Sort object members alphabetically (case-insensitive).
    pub fn cJSONUtils_SortObject(object: *mut cJSON);

    /// Sort object members alphabetically (case-sensitive).
    pub fn cJSONUtils_SortObjectCaseSensitive(object: *mut cJSON);
}