opendp-ffi 0.4.0

Foreign function interfaces for the OpenDP library.
Documentation
{
    "to_string": {
        "description": "Internal function. Convert the AnyObject to a string representation.",
        "args": [
            {"name": "this", "c_type": "const AnyObject *"}
        ],
        "ret": {
            "c_type": "FfiResult<const char *>",
            "description": "String representation of `this` AnyObject."
        }
    },
    "slice_as_object": {
        "description": "Internal function. Load data from a `slice` into an AnyObject",
        "args": [
            {"name": "slice", "c_type": "const FfiSlice *", "rust_type": "T", "hint": "FfiSlicePtr"},
            {"name": "T", "is_type": true}
        ],
        "ret": {
            "c_type": "FfiResult<const AnyObject *>",
            "do_not_convert": true,
            "description": "An AnyObject that contains the data in `slice`. The AnyObject also captures rust type information."
        }
    },
    "object_type": {
        "description": "Internal function. Retrieve the type descriptor string of an AnyObject.",
        "args": [
            {"name": "this", "c_type": "const AnyObject *"}
        ],
        "ret": {
            "c_type": "FfiResult<const char *>",
            "description": "The rust type associated with `this` AnyObject."
        }
    },
    "object_as_slice": {
        "description": "Internal function. Unload data from an AnyObject into an FfiSlicePtr.",
        "args": [
            {"name": "this", "c_type": "const AnyObject *"}
        ],
        "ret": {
            "c_type": "FfiResult<const FfiSlice *>",
            "do_not_convert": true,
            "description": "An FfiSlice that contains the data in FfiObject, but in a format readable in bindings languages."
        }
    },
    "object_free": {
        "description": "Internal function. Free the memory associated with `this`, an AnyObject.",
        "args": [
            {
                "name": "this",
                "c_type": "const AnyObject *",
                "do_not_convert": true
            }
        ],
        "ret": {"c_type": "FfiResult<void *>"}
    },
    "slice_free": {
        "description": "Internal function. Free the memory associated with `this`, an FfiSlicePtr. \nUsed to clean up after object_as_slice.",
        "args": [
            {
                "name": "this",
                "c_type": "const FfiSlice *",
                "do_not_convert": true
            }
        ],
        "ret": {"c_type": "FfiResult<void *>"}
    },
    "str_free": {
        "description": "Internal function. Free the memory associated with `this`, a string. \nUsed to clean up after the type getter functions.",
        "args": [
            {
                "name": "this",
                "c_type": "const char *",
                "do_not_convert": true
            }
        ],
        "ret": {"c_type": "FfiResult<void *>"}
    },
    "bool_free": {
        "description": "Internal function. Free the memory associated with `this`, a bool. \nUsed to clean up after the relation check.",
        "args": [
            {
                "name": "this",
                "c_type": "bool *",
                "do_not_convert": true
            }
        ],
        "ret": {"c_type": "FfiResult<void *>"}
    }
}