zova-sys 1.4.0

Raw Rust FFI bindings for Zova's C ABI.
Documentation
//! Raw layouts for include/zova_plugin.h. These are unsafe authoring primitives,
//! not safe callbacks or a loader. Never retain a call's host/connection or row
//! buffers, reenter its connection, unwind across C, or cross allocator owners.
use std::os::raw::{c_char, c_void};

pub const ZOVA_PLUGIN_ABI_V1: u32 = 1;
pub const ZOVA_PLUGIN_OK: i32 = 0;
pub const ZOVA_PLUGIN_ERROR: i32 = 1;
pub const ZOVA_PLUGIN_OUT_OF_MEMORY: i32 = 2;
pub const ZOVA_PLUGIN_INVALID_ARGUMENT: i32 = 3;
pub const ZOVA_PLUGIN_UNSUPPORTED: i32 = 4;
pub const ZOVA_PLUGIN_LIMIT: i32 = 5;
pub const ZOVA_PLUGIN_CANCELED: i32 = 6;
pub const ZOVA_PLUGIN_HAS_UPGRADE_V1: u64 = 1;
pub const ZOVA_PLUGIN_HAS_DATA_COMPATIBILITY_V1: u64 = 128;
pub const ZOVA_PLUGIN_HAS_RECOVERY_V1: u64 = 256;
pub const ZOVA_PLUGIN_SALVAGE_PLAN: u32 = 1;
pub const ZOVA_PLUGIN_SALVAGE_COPY: u32 = 2;
pub const ZOVA_PLUGIN_REQUIRES_QUERY_V1: u64 = 2;
pub const ZOVA_PLUGIN_REQUIRES_DIAGNOSTICS_V1: u64 = 4;
pub const ZOVA_PLUGIN_SERVICE_QUERY: u32 = 1;
pub const ZOVA_PLUGIN_SERVICE_DIAGNOSTICS: u32 = 2;
pub const ZOVA_PLUGIN_REQUIRES_DATA_V1: u64 = 8;
pub const ZOVA_PLUGIN_REQUIRES_STORAGE_V1: u64 = 16;
pub const ZOVA_PLUGIN_SERVICE_DATA: u32 = 3;
pub const ZOVA_PLUGIN_SERVICE_STORAGE: u32 = 4;
pub const ZOVA_PLUGIN_REQUIRES_OPERATIONS_V1: u64 = 32;
pub const ZOVA_PLUGIN_SERVICE_OPERATIONS: u32 = 5;
pub const ZOVA_PLUGIN_SERVICE_VECTOR_MAINTENANCE: u32 = 6;
pub const ZOVA_PLUGIN_REQUIRES_VECTOR_MAINTENANCE_V1: u64 = 64;
pub const ZOVA_PLUGIN_HISTORY_UNAVAILABLE: i32 = 7;
pub const ZOVA_PLUGIN_SOURCE_CHANGED: i32 = 8;

#[repr(C)]
#[derive(Clone, Copy, Debug, Default)]
pub struct zova_plugin_vector_view_v1 {
    pub incarnation: [u8; 16],
    pub token: [u8; 16],
    pub revision: i64,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_vector_changes_request_v1 {
    pub struct_size: u32,
    pub reserved: u32,
    pub name: zova_plugin_bytes_v1,
    pub since: zova_plugin_vector_view_v1,
    pub after_revision: i64,
    pub row_limit: u64,
    pub byte_limit: u64,
    pub row: zova_plugin_row_v1,
    pub user_data: *mut c_void,
}

#[repr(C)]
#[derive(Clone, Copy, Debug, Default)]
pub struct zova_plugin_vector_changes_page_v1 {
    pub view: zova_plugin_vector_view_v1,
    pub rows: u64,
    pub next_revision: i64,
    pub has_more: u32,
    pub reserved: u32,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_vector_maintenance_service_v1 {
    pub struct_size: u32,
    pub version: u32,
    pub view: Option<
        unsafe extern "C" fn(
            *mut c_void,
            zova_plugin_bytes_v1,
            *mut zova_plugin_vector_view_v1,
        ) -> i32,
    >,
    pub read_changes: Option<
        unsafe extern "C" fn(
            *mut c_void,
            *const zova_plugin_vector_changes_request_v1,
            *mut zova_plugin_vector_changes_page_v1,
        ) -> i32,
    >,
}
pub const ZOVA_PLUGIN_OPERATION_SCALAR: u32 = 1;
pub const ZOVA_PLUGIN_OPERATION_TABLE: u32 = 2;
pub const ZOVA_PLUGIN_OPERATION_EXACT: u64 = 1;
pub const ZOVA_PLUGIN_OPERATION_APPROXIMATE: u64 = 2;
pub const ZOVA_PLUGIN_OPERATION_MUTATING: u64 = 4;
pub const ZOVA_PLUGIN_OPERATION_ORDERED: u64 = 8;
pub const ZOVA_PLUGIN_GRAPH_NODES_SCAN: u32 = 1;
pub const ZOVA_PLUGIN_GRAPH_EDGES_SCAN: u32 = 2;
pub const ZOVA_PLUGIN_GRAPH_NODES_GET: u32 = 3;
pub const ZOVA_PLUGIN_GRAPH_EDGES_GET: u32 = 4;
pub const ZOVA_PLUGIN_GRAPH_NEIGHBORS: u32 = 5;
pub const ZOVA_PLUGIN_VECTOR_METADATA: u32 = 6;
pub const ZOVA_PLUGIN_VECTORS_SCAN: u32 = 7;
pub const ZOVA_PLUGIN_VECTORS_GET: u32 = 8;
pub const ZOVA_PLUGIN_GRAPH_EDGE_PAYLOADS_GET: u32 = 9;
pub const ZOVA_PLUGIN_GRAPH_NEIGHBORS_KEYED: u32 = 10;
pub const ZOVA_PLUGIN_OUTGOING: u32 = 0;
pub const ZOVA_PLUGIN_INCOMING: u32 = 1;
pub const ZOVA_PLUGIN_VALUE_NULL: u32 = 0;
pub const ZOVA_PLUGIN_VALUE_INTEGER: u32 = 1;
pub const ZOVA_PLUGIN_VALUE_FLOAT: u32 = 2;
pub const ZOVA_PLUGIN_VALUE_TEXT: u32 = 3;
pub const ZOVA_PLUGIN_VALUE_BLOB: u32 = 4;

pub type zova_plugin_hook_v1 =
    Option<unsafe extern "C" fn(*const zova_plugin_host_v1, *mut c_void) -> i32>;
pub type zova_plugin_row_v1 =
    Option<unsafe extern "C" fn(*mut c_void, *const zova_plugin_value_v1, u64) -> i32>;

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_host_v1 {
    pub struct_size: u32,
    pub abi_version: u32,
    pub exec_sql: Option<unsafe extern "C" fn(*mut c_void, *const c_char, u64) -> i32>,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_service_host_v1 {
    pub base: zova_plugin_host_v1,
    pub get_service:
        Option<unsafe extern "C" fn(*mut c_void, u32, u32, u32, *mut *const c_void) -> i32>,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_descriptor_v1 {
    pub struct_size: u32,
    pub abi_version: u32,
    pub flags: u64,
    pub name: *const c_char,
    pub version: *const c_char,
    pub storage_prefix: *const c_char,
    pub zova_abi_min: *const c_char,
    pub capabilities: *const c_char,
    pub install: zova_plugin_hook_v1,
    pub check: zova_plugin_hook_v1,
    pub drop: zova_plugin_hook_v1,
    pub register_sql: zova_plugin_hook_v1,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_upgrade_descriptor_v1 {
    pub base: zova_plugin_descriptor_v1,
    pub from_version: *const c_char,
    pub upgrade: zova_plugin_hook_v1,
}

/// Opt-in code/data compatibility. Strings are immutable until library unload.
/// The upgrade prefix is present even when HAS_UPGRADE_V1 is not set.
#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_compatibility_descriptor_v1 {
    pub base: zova_plugin_upgrade_descriptor_v1,
    pub data_version: *const c_char,
    pub accepted_data_versions: *const c_char,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_salvage_request_v1 {
    pub struct_size: u32,
    pub mode: u32,
    pub data_version: zova_plugin_bytes_v1,
}
#[repr(C)]
#[derive(Clone, Copy, Debug, Default)]
pub struct zova_plugin_salvage_result_v1 {
    pub copied_extensions: u64,
    pub copied_private_objects: u64,
    pub skipped_extensions: u64,
    pub skipped_private_objects: u64,
    pub installed_in_destination: u32,
    pub reserved: u32,
}
pub type zova_plugin_rebuild_v1 = Option<
    unsafe extern "C" fn(*const zova_plugin_host_v1, *mut c_void, zova_plugin_bytes_v1) -> i32,
>;
pub type zova_plugin_salvage_v1 = Option<
    unsafe extern "C" fn(
        *const zova_plugin_host_v1,
        *mut c_void,
        *const zova_plugin_host_v1,
        *mut c_void,
        *const zova_plugin_salvage_request_v1,
        *mut zova_plugin_salvage_result_v1,
    ) -> i32,
>;
#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_recovery_descriptor_v1 {
    pub base: zova_plugin_compatibility_descriptor_v1,
    pub rebuild: zova_plugin_rebuild_v1,
    pub salvage: zova_plugin_salvage_v1,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_value_v1 {
    pub kind: u32,
    pub reserved: u32,
    pub integer: i64,
    pub real: f64,
    pub bytes: *const u8,
    pub bytes_len: u64,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_query_request_v1 {
    pub struct_size: u32,
    pub flags: u32,
    pub sql: *const c_char,
    pub sql_len: u64,
    pub parameters: *const zova_plugin_value_v1,
    pub parameter_count: u64,
    pub row_limit: u64,
    pub byte_limit: u64,
    pub row: zova_plugin_row_v1,
    pub user_data: *mut c_void,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_query_service_v1 {
    pub struct_size: u32,
    pub version: u32,
    pub query:
        Option<unsafe extern "C" fn(*mut c_void, *const zova_plugin_query_request_v1) -> i32>,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_diagnostics_service_v1 {
    pub struct_size: u32,
    pub version: u32,
    pub copy_sqlite_error: Option<unsafe extern "C" fn(*mut c_void, *mut u8, u64, *mut u64) -> i32>,
}

pub type zova_plugin_entry_v1 = unsafe extern "C" fn(u32) -> *const zova_plugin_descriptor_v1;

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_bytes_v1 {
    pub data: *const u8,
    pub len: u64,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_operation_column_v1 {
    pub name: zova_plugin_bytes_v1,
    pub kind: u32,
    pub nullable: u32,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_operation_call_v1 {
    pub struct_size: u32,
    pub reserved: u32,
    pub arguments: *const zova_plugin_value_v1,
    pub argument_count: u64,
    pub row: zova_plugin_row_v1,
    pub user_data: *mut c_void,
}

pub type zova_plugin_operation_close_v1 = Option<unsafe extern "C" fn(*mut c_void)>;
pub type zova_plugin_scalar_v1 = Option<
    unsafe extern "C" fn(
        *const zova_plugin_host_v1,
        *mut c_void,
        *mut c_void,
        *const zova_plugin_operation_call_v1,
    ) -> i32,
>;
pub type zova_plugin_operation_open_v1 = Option<
    unsafe extern "C" fn(
        *const zova_plugin_host_v1,
        *mut c_void,
        *mut c_void,
        *const zova_plugin_value_v1,
        u64,
        *mut *mut c_void,
    ) -> i32,
>;
pub type zova_plugin_operation_next_v1 = Option<
    unsafe extern "C" fn(
        *const zova_plugin_host_v1,
        *mut c_void,
        *mut c_void,
        zova_plugin_row_v1,
        *mut c_void,
        *mut u32,
    ) -> i32,
>;

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_operation_v1 {
    pub struct_size: u32,
    pub kind: u32,
    pub flags: u64,
    pub name: zova_plugin_bytes_v1,
    pub arguments: *const zova_plugin_operation_column_v1,
    pub argument_count: u32,
    pub column_count: u32,
    pub columns: *const zova_plugin_operation_column_v1,
    pub user_data: *mut c_void,
    pub destroy: zova_plugin_operation_close_v1,
    pub scalar: zova_plugin_scalar_v1,
    pub open: zova_plugin_operation_open_v1,
    pub next: zova_plugin_operation_next_v1,
    pub close: zova_plugin_operation_close_v1,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_operation_service_v1 {
    pub struct_size: u32,
    pub version: u32,
    pub register_operation:
        Option<unsafe extern "C" fn(*mut c_void, *const zova_plugin_operation_v1) -> i32>,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_cursor_v1 {
    pub created_order: i64,
    pub key: i64,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_data_page_v1 {
    pub rows: u64,
    pub has_more: u32,
    pub reserved: u32,
    pub next: zova_plugin_cursor_v1,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_data_request_v1 {
    pub struct_size: u32,
    pub operation: u32,
    pub name: zova_plugin_bytes_v1,
    pub keys: *const i64,
    pub key_count: u64,
    pub ids: *const zova_plugin_bytes_v1,
    pub id_count: u64,
    pub after: zova_plugin_cursor_v1,
    pub after_id: zova_plugin_bytes_v1,
    pub node_id: zova_plugin_bytes_v1,
    pub edge_type: zova_plugin_bytes_v1,
    pub direction: u32,
    pub reserved: u32,
    pub row_limit: u64,
    pub byte_limit: u64,
    pub row: zova_plugin_row_v1,
    pub user_data: *mut c_void,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_data_service_v1 {
    pub struct_size: u32,
    pub version: u32,
    pub read: Option<
        unsafe extern "C" fn(
            *mut c_void,
            *const zova_plugin_data_request_v1,
            *mut zova_plugin_data_page_v1,
        ) -> i32,
    >,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct zova_plugin_storage_service_v1 {
    pub struct_size: u32,
    pub version: u32,
    pub execute:
        Option<unsafe extern "C" fn(*mut c_void, *const zova_plugin_query_request_v1) -> i32>,
}