fastdb-sys 0.2.0

//! Mechanical declarations for the stable FastDB portable-payload C ABI.

#![allow(non_camel_case_types)]

use std::ffi::c_void;

pub const FDB_PAYLOAD_V1_ABI_VERSION: u32 = 1;
pub const FDB_PAYLOAD_V1_SHA256_SIZE: u32 = 32;
pub const FDB_PAYLOAD_V1_COMPILE_OPTIONS_V1_SIZE: u32 = 80;
pub const FDB_PAYLOAD_V1_CAPABILITIES_V1_SIZE: u32 = 72;
pub const FDB_PAYLOAD_V1_BUILDER_OPTIONS_V2_SIZE: u32 = 96;
pub const FDB_PAYLOAD_V1_FIXED_RUN_V1_SIZE: u32 = 96;
pub const FDB_PAYLOAD_V1_OPEN_OPTIONS_V1_SIZE: u32 = 112;
pub const FDB_PAYLOAD_V1_PLAN_INFO_V2_SIZE: u32 = 112;
pub const FDB_PAYLOAD_V1_EXECUTION_REPORT_V1_SIZE: u32 = 72;
pub const FDB_PAYLOAD_V1_CODEGEN_OPTIONS_V1_SIZE: u32 = 48;
pub const FDB_PAYLOAD_V1_BACKING_V1_SIZE: u32 = 96;
pub const FDB_PAYLOAD_V1_INVALID_OBJECT_HANDLE: u64 = 0;

pub const FDB_PAYLOAD_PROFILE_RECORD_V1: u32 = 1;
pub const FDB_PAYLOAD_PROFILE_OBJECT_GRAPH_V1: u32 = 2;

pub const FDB_PAYLOAD_BUILD_ALLOW_STAGING: u32 = 1;
pub const FDB_PAYLOAD_BUILD_REQUIRE_DIRECT: u32 = 2;
pub const FDB_PAYLOAD_RESERVE_DIRECT: u32 = 1;
pub const FDB_PAYLOAD_RESERVE_STAGED: u32 = 2;
pub const FDB_PAYLOAD_EXECUTION_DIRECT: u32 = 1;
pub const FDB_PAYLOAD_EXECUTION_STAGED: u32 = 2;
pub const FDB_PAYLOAD_FALLBACK_NONE: u32 = 0;
pub const FDB_PAYLOAD_FALLBACK_PLAN_REQUIRES_STAGING: u32 = 1;
pub const FDB_PAYLOAD_FALLBACK_BACKING_DECLINED_DIRECT: u32 = 2;
pub const FDB_PAYLOAD_OPEN_VALIDATE_TEXT_EAGER: u32 = 1;

pub const FDB_PAYLOAD_CODEGEN_TARGET_CPP: u64 = 1 << 0;
pub const FDB_PAYLOAD_CODEGEN_TARGET_RUST: u64 = 1 << 1;
pub const FDB_PAYLOAD_CODEGEN_TARGET_PYTHON: u64 = 1 << 2;
pub const FDB_PAYLOAD_CODEGEN_TARGET_TYPESCRIPT: u64 = 1 << 3;
pub const FDB_PAYLOAD_ARTIFACT_SOURCE: u32 = 1;

pub const FDB_PAYLOAD_VIEW_SEQUENCE: u32 = 1;
pub const FDB_PAYLOAD_VIEW_BOOL: u32 = 2;
pub const FDB_PAYLOAD_VIEW_U8: u32 = 3;
pub const FDB_PAYLOAD_VIEW_U16: u32 = 4;
pub const FDB_PAYLOAD_VIEW_U32: u32 = 5;
pub const FDB_PAYLOAD_VIEW_I32: u32 = 6;
pub const FDB_PAYLOAD_VIEW_U8N: u32 = 7;
pub const FDB_PAYLOAD_VIEW_U16N: u32 = 8;
pub const FDB_PAYLOAD_VIEW_F32: u32 = 9;
pub const FDB_PAYLOAD_VIEW_F64: u32 = 10;
pub const FDB_PAYLOAD_VIEW_STR: u32 = 11;
pub const FDB_PAYLOAD_VIEW_WSTR: u32 = 12;
pub const FDB_PAYLOAD_VIEW_BYTES: u32 = 13;
pub const FDB_PAYLOAD_VIEW_COMPONENT: u32 = 14;
pub const FDB_PAYLOAD_VIEW_LIST: u32 = 15;
pub const FDB_PAYLOAD_VIEW_REF: u32 = 16;

pub const FDB_PAYLOAD_E_DIRECT_UNAVAILABLE: u32 = 2007;
pub const FDB_PAYLOAD_E_DIGEST_MISMATCH: u32 = 3006;
pub const FDB_PAYLOAD_E_BACKING_CONTRACT: u32 = 5001;
pub const FDB_PAYLOAD_E_ALLOCATION_FAILED: u32 = 5002;
pub const FDB_PAYLOAD_E_COMMIT_FAILED: u32 = 5003;
pub const FDB_PAYLOAD_E_ROLLBACK_FAILED: u32 = 5004;
pub const FDB_PAYLOAD_E_UNSUPPORTED_TARGET: u32 = 6001;
pub const FDB_PAYLOAD_E_INVALID_ARTIFACT_PATH: u32 = 6002;
pub const FDB_PAYLOAD_E_GENERATOR_FAILED: u32 = 6003;
pub const FDB_PAYLOAD_E_UNSUPPORTED_ABI: u32 = 7002;
pub const FDB_PAYLOAD_E_INDEX_OUT_OF_RANGE: u32 = 7004;
pub const FDB_PAYLOAD_E_INTERNAL: u32 = 9001;

pub type fdb_payload_v1_status_t = u32;
pub type fdb_payload_v1_profile_t = u32;
pub type fdb_payload_v1_codegen_target_t = u64;
pub type fdb_payload_v1_artifact_kind_t = u32;

#[repr(C)]
pub struct fdb_payload_v1_spec_t {
    _private: [u8; 0],
    _marker: std::marker::PhantomData<(*mut u8, std::marker::PhantomPinned)>,
}

#[repr(C)]
pub struct fdb_payload_v1_blob_t {
    _private: [u8; 0],
    _marker: std::marker::PhantomData<(*mut u8, std::marker::PhantomPinned)>,
}

#[repr(C)]
pub struct fdb_payload_v1_error_t {
    _private: [u8; 0],
    _marker: std::marker::PhantomData<(*mut u8, std::marker::PhantomPinned)>,
}

#[repr(C)]
pub struct fdb_payload_v1_builder_t {
    _private: [u8; 0],
    _marker: std::marker::PhantomData<(*mut u8, std::marker::PhantomPinned)>,
}

#[repr(C)]
pub struct fdb_payload_v1_plan_t {
    _private: [u8; 0],
    _marker: std::marker::PhantomData<(*mut u8, std::marker::PhantomPinned)>,
}

#[repr(C)]
pub struct fdb_payload_v1_payload_t {
    _private: [u8; 0],
    _marker: std::marker::PhantomData<(*mut u8, std::marker::PhantomPinned)>,
}

#[repr(C)]
pub struct fdb_payload_v1_view_t {
    _private: [u8; 0],
    _marker: std::marker::PhantomData<(*mut u8, std::marker::PhantomPinned)>,
}

#[repr(C)]
pub struct fdb_payload_v1_access_t {
    _private: [u8; 0],
    _marker: std::marker::PhantomData<(*mut u8, std::marker::PhantomPinned)>,
}

#[repr(C)]
pub struct fdb_payload_v1_codegen_result_t {
    _private: [u8; 0],
    _marker: std::marker::PhantomData<(*mut u8, std::marker::PhantomPinned)>,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct fdb_payload_v1_compile_options_t {
    pub struct_size: u32,
    pub flags: u32,
    pub max_source_bytes: u64,
    pub max_json_values: u64,
    pub max_nesting_depth: u32,
    pub max_entries: u32,
    pub max_components: u32,
    pub max_fields_per_component: u32,
    pub max_total_fields: u64,
    pub reserved: [u64; 4],
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct fdb_payload_v1_capabilities_t {
    pub struct_size: u32,
    pub profile: u32,
    pub semantic_flags: u64,
    pub operation_flags: u64,
    pub codegen_target_flags: u64,
    pub direct_build_status: u32,
    pub reserved32: u32,
    pub reserved64: [u64; 4],
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct fdb_payload_v1_builder_options_t {
    pub struct_size: u32,
    pub flags: u32,
    pub max_value_nodes: u64,
    pub max_list_elements: u64,
    pub max_text_bytes: u64,
    pub max_opaque_bytes: u64,
    pub max_nesting_depth: u64,
    pub max_total_builder_bytes: u64,
    pub reserved: [u64; 4],
    pub max_graph_objects: u64,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct fdb_payload_v1_fixed_run_v1_t {
    pub struct_size: u32,
    pub flags: u32,
    pub data: *const c_void,
    pub data_byte_length: u64,
    pub count: u64,
    pub stride_bytes: u64,
    pub validity: *const u8,
    pub validity_byte_length: u64,
    pub validity_bit_offset: u64,
    pub reserved: [u64; 4],
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct fdb_payload_v1_plan_info_t {
    pub struct_size: u32,
    pub flags: u32,
    pub total_bytes: u64,
    pub region_count: u64,
    pub logical_value_count: u64,
    pub list_element_count: u64,
    pub text_bytes: u64,
    pub opaque_bytes: u64,
    pub validation_work: u64,
    pub max_alignment: u32,
    pub direct_build_status: u32,
    pub reserved: [u64; 4],
    pub graph_object_count: u64,
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct fdb_payload_v1_open_options_t {
    pub struct_size: u32,
    pub flags: u32,
    pub max_total_bytes: u64,
    pub max_regions: u64,
    pub max_entries: u64,
    pub max_components: u64,
    pub max_nesting_depth: u64,
    pub max_list_elements: u64,
    pub max_graph_objects: u64,
    pub max_string_bytes: u64,
    pub max_validation_work: u64,
    pub reserved: [u64; 4],
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct fdb_payload_v1_execution_report_t {
    pub struct_size: u32,
    pub mode: u32,
    pub fallback_reason: u32,
    pub reserved32: u32,
    pub requested_bytes: u64,
    pub used_bytes: u64,
    pub staging_bytes: u64,
    pub region_count: u64,
    pub backing_capacity: u64,
    pub reserved64: [u64; 2],
}

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct fdb_payload_v1_codegen_options_t {
    pub struct_size: u32,
    pub flags: u32,
    pub max_artifacts: u64,
    pub max_total_bytes: u64,
    pub reserved: [u64; 3],
}

pub type fdb_payload_v1_backing_reserve_fn = unsafe extern "C" fn(
    context: *mut c_void,
    reserve_mode: u32,
    minimum_capacity: u64,
    alignment: u32,
    out_owner_token: *mut *mut c_void,
    out_writable_data: *mut *mut u8,
    out_capacity: *mut u64,
) -> fdb_payload_v1_status_t;
pub type fdb_payload_v1_backing_write_fn = unsafe extern "C" fn(
    context: *mut c_void,
    owner_token: *mut c_void,
    offset: u64,
    source: *const u8,
    source_size: u64,
) -> fdb_payload_v1_status_t;
pub type fdb_payload_v1_backing_commit_fn = unsafe extern "C" fn(
    context: *mut c_void,
    owner_token: *mut c_void,
    used_size: u64,
    out_readable_data: *mut *const u8,
    out_readable_size: *mut u64,
) -> fdb_payload_v1_status_t;
pub type fdb_payload_v1_backing_rollback_fn =
    unsafe extern "C" fn(context: *mut c_void, owner_token: *mut c_void) -> fdb_payload_v1_status_t;
pub type fdb_payload_v1_backing_retain_fn =
    unsafe extern "C" fn(context: *mut c_void, owner_token: *mut c_void) -> fdb_payload_v1_status_t;
pub type fdb_payload_v1_backing_release_fn =
    unsafe extern "C" fn(context: *mut c_void, owner_token: *mut c_void);

#[repr(C)]
#[derive(Clone, Copy, Debug)]
pub struct fdb_payload_v1_backing_v1_t {
    pub struct_size: u32,
    pub flags: u32,
    pub context: *mut c_void,
    pub reserve: Option<fdb_payload_v1_backing_reserve_fn>,
    pub write: Option<fdb_payload_v1_backing_write_fn>,
    pub commit: Option<fdb_payload_v1_backing_commit_fn>,
    pub rollback: Option<fdb_payload_v1_backing_rollback_fn>,
    pub retain: Option<fdb_payload_v1_backing_retain_fn>,
    pub release: Option<fdb_payload_v1_backing_release_fn>,
    pub reserved: [u64; 4],
}

unsafe extern "C" {
    pub fn fdb_payload_v1_abi_version() -> u32;
    pub fn fdb_payload_v1_compile_options_init(options: *mut fdb_payload_v1_compile_options_t);
    pub fn fdb_payload_v1_capabilities_init(capabilities: *mut fdb_payload_v1_capabilities_t);
    pub fn fdb_payload_v1_builder_options_init(options: *mut fdb_payload_v1_builder_options_t);
    pub fn fdb_payload_v1_fixed_run_init(run: *mut fdb_payload_v1_fixed_run_v1_t);
    pub fn fdb_payload_v1_open_options_init(options: *mut fdb_payload_v1_open_options_t);
    pub fn fdb_payload_v1_plan_info_init(info: *mut fdb_payload_v1_plan_info_t);
    pub fn fdb_payload_v1_execution_report_init(report: *mut fdb_payload_v1_execution_report_t);
    pub fn fdb_payload_v1_codegen_options_init(options: *mut fdb_payload_v1_codegen_options_t);
    pub fn fdb_payload_v1_backing_init(backing: *mut fdb_payload_v1_backing_v1_t);

    pub fn fdb_payload_v1_spec_compile_json(
        source: *const u8,
        source_size: u64,
        options: *const fdb_payload_v1_compile_options_t,
        out_spec: *mut *mut fdb_payload_v1_spec_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_retain(spec: *mut fdb_payload_v1_spec_t);
    pub fn fdb_payload_v1_spec_release(spec: *mut fdb_payload_v1_spec_t);
    pub fn fdb_payload_v1_spec_codegen(
        spec: *const fdb_payload_v1_spec_t,
        target: fdb_payload_v1_codegen_target_t,
        options: *const fdb_payload_v1_codegen_options_t,
        out_result: *mut *mut fdb_payload_v1_codegen_result_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_codegen_result_retain(result: *mut fdb_payload_v1_codegen_result_t);
    pub fn fdb_payload_v1_codegen_result_release(result: *mut fdb_payload_v1_codegen_result_t);
    pub fn fdb_payload_v1_codegen_result_artifact_count(
        result: *const fdb_payload_v1_codegen_result_t,
        out_count: *mut u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_codegen_result_artifact_relative_path(
        result: *const fdb_payload_v1_codegen_result_t,
        artifact_index: u64,
        out_path: *mut *mut fdb_payload_v1_blob_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_codegen_result_artifact_kind(
        result: *const fdb_payload_v1_codegen_result_t,
        artifact_index: u64,
        out_kind: *mut fdb_payload_v1_artifact_kind_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_codegen_result_artifact_bytes(
        result: *const fdb_payload_v1_codegen_result_t,
        artifact_index: u64,
        out_bytes: *mut *mut fdb_payload_v1_blob_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_codegen_result_artifact_sha256(
        result: *const fdb_payload_v1_codegen_result_t,
        artifact_index: u64,
        out_digest: *mut u8,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_canonical_json(
        spec: *const fdb_payload_v1_spec_t,
        out_blob: *mut *mut fdb_payload_v1_blob_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_sha256(
        spec: *const fdb_payload_v1_spec_t,
        out_digest: *mut u8,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_manifest_json(
        spec: *const fdb_payload_v1_spec_t,
        out_blob: *mut *mut fdb_payload_v1_blob_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_profile(
        spec: *const fdb_payload_v1_spec_t,
        out_profile: *mut fdb_payload_v1_profile_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_capabilities(
        spec: *const fdb_payload_v1_spec_t,
        out_capabilities: *mut fdb_payload_v1_capabilities_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_entry_count(
        spec: *const fdb_payload_v1_spec_t,
        out_count: *mut u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_entry_id(
        spec: *const fdb_payload_v1_spec_t,
        entry_index: u32,
        out_id: *mut *mut fdb_payload_v1_blob_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_entry_index(
        spec: *const fdb_payload_v1_spec_t,
        id: *const u8,
        id_size: u64,
        out_entry_index: *mut u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_component_count(
        spec: *const fdb_payload_v1_spec_t,
        out_count: *mut u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_component_id(
        spec: *const fdb_payload_v1_spec_t,
        component_index: u32,
        out_id: *mut *mut fdb_payload_v1_blob_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_component_index(
        spec: *const fdb_payload_v1_spec_t,
        id: *const u8,
        id_size: u64,
        out_component_index: *mut u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_component_field_count(
        spec: *const fdb_payload_v1_spec_t,
        component_index: u32,
        out_count: *mut u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_component_field_id(
        spec: *const fdb_payload_v1_spec_t,
        component_index: u32,
        field_index: u32,
        out_id: *mut *mut fdb_payload_v1_blob_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_spec_component_field_index(
        spec: *const fdb_payload_v1_spec_t,
        component_index: u32,
        id: *const u8,
        id_size: u64,
        out_field_index: *mut u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;

    pub fn fdb_payload_v1_builder_create(
        spec: *const fdb_payload_v1_spec_t,
        options: *const fdb_payload_v1_builder_options_t,
        out_builder: *mut *mut fdb_payload_v1_builder_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_release(builder: *mut fdb_payload_v1_builder_t);
    pub fn fdb_payload_v1_builder_require_spec_sha256(
        builder: *const fdb_payload_v1_builder_t,
        expected_sha256: *const u8,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_entry_begin(
        builder: *mut fdb_payload_v1_builder_t,
        entry_index: u32,
        value_count: u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_object_declare(
        builder: *mut fdb_payload_v1_builder_t,
        component_index: u32,
        out_object: *mut u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_object_fill_begin(
        builder: *mut fdb_payload_v1_builder_t,
        object: u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_null(
        builder: *mut fdb_payload_v1_builder_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_bool(
        builder: *mut fdb_payload_v1_builder_t,
        value: u8,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_u8(
        builder: *mut fdb_payload_v1_builder_t,
        value: u8,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_u16(
        builder: *mut fdb_payload_v1_builder_t,
        value: u16,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_u32(
        builder: *mut fdb_payload_v1_builder_t,
        value: u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_i32(
        builder: *mut fdb_payload_v1_builder_t,
        value: i32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_u8n_f64_bits(
        builder: *mut fdb_payload_v1_builder_t,
        value: u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_u16n_f64_bits(
        builder: *mut fdb_payload_v1_builder_t,
        value: u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_f32_bits(
        builder: *mut fdb_payload_v1_builder_t,
        value: u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_f64_bits(
        builder: *mut fdb_payload_v1_builder_t,
        value: u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_str(
        builder: *mut fdb_payload_v1_builder_t,
        value: *const u8,
        value_size: u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_wstr(
        builder: *mut fdb_payload_v1_builder_t,
        value: *const u16,
        value_size: u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_bytes(
        builder: *mut fdb_payload_v1_builder_t,
        value: *const u8,
        value_size: u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_fixed_run(
        builder: *mut fdb_payload_v1_builder_t,
        run: *const fdb_payload_v1_fixed_run_v1_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_component_begin(
        builder: *mut fdb_payload_v1_builder_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_list_begin(
        builder: *mut fdb_payload_v1_builder_t,
        item_count: u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_object(
        builder: *mut fdb_payload_v1_builder_t,
        object: u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_value_ref(
        builder: *mut fdb_payload_v1_builder_t,
        object: u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_builder_freeze(
        builder: *mut fdb_payload_v1_builder_t,
        out_plan: *mut *mut fdb_payload_v1_plan_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;

    pub fn fdb_payload_v1_plan_retain(plan: *mut fdb_payload_v1_plan_t);
    pub fn fdb_payload_v1_plan_release(plan: *mut fdb_payload_v1_plan_t);
    pub fn fdb_payload_v1_plan_info(
        plan: *const fdb_payload_v1_plan_t,
        out_info: *mut fdb_payload_v1_plan_info_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_plan_execute(
        plan: *const fdb_payload_v1_plan_t,
        policy: u32,
        backing: *const fdb_payload_v1_backing_v1_t,
        out_payload: *mut *mut fdb_payload_v1_payload_t,
        out_report: *mut fdb_payload_v1_execution_report_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;

    pub fn fdb_payload_v1_payload_open_copy(
        spec: *const fdb_payload_v1_spec_t,
        bytes: *const u8,
        byte_count: u64,
        options: *const fdb_payload_v1_open_options_t,
        out_payload: *mut *mut fdb_payload_v1_payload_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_payload_open_external(
        spec: *const fdb_payload_v1_spec_t,
        bytes: *const u8,
        byte_count: u64,
        backing: *const fdb_payload_v1_backing_v1_t,
        owner_token: *mut c_void,
        options: *const fdb_payload_v1_open_options_t,
        out_payload: *mut *mut fdb_payload_v1_payload_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_payload_retain(payload: *mut fdb_payload_v1_payload_t);
    pub fn fdb_payload_v1_payload_release(payload: *mut fdb_payload_v1_payload_t);
    pub fn fdb_payload_v1_payload_require_spec_sha256(
        payload: *const fdb_payload_v1_payload_t,
        expected_sha256: *const u8,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_payload_sha256(
        payload: *const fdb_payload_v1_payload_t,
        out_digest: *mut u8,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_payload_profile(
        payload: *const fdb_payload_v1_payload_t,
        out_profile: *mut fdb_payload_v1_profile_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_payload_execution_report(
        payload: *const fdb_payload_v1_payload_t,
        out_report: *mut fdb_payload_v1_execution_report_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_payload_binary_blob(
        payload: *const fdb_payload_v1_payload_t,
        out_blob: *mut *mut fdb_payload_v1_blob_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_payload_acquire(
        payload: *const fdb_payload_v1_payload_t,
        out_access: *mut *mut fdb_payload_v1_access_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_payload_entry_view(
        payload: *const fdb_payload_v1_payload_t,
        entry_index: u32,
        out_view: *mut *mut fdb_payload_v1_view_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;

    pub fn fdb_payload_v1_view_retain(view: *mut fdb_payload_v1_view_t);
    pub fn fdb_payload_v1_view_release(view: *mut fdb_payload_v1_view_t);
    pub fn fdb_payload_v1_view_require_spec_sha256(
        view: *const fdb_payload_v1_view_t,
        expected_sha256: *const u8,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_kind(
        view: *const fdb_payload_v1_view_t,
        out_kind: *mut u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_is_null(
        view: *const fdb_payload_v1_view_t,
        out_is_null: *mut u8,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_length(
        view: *const fdb_payload_v1_view_t,
        out_length: *mut u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_at(
        view: *const fdb_payload_v1_view_t,
        index: u64,
        out_child: *mut *mut fdb_payload_v1_view_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_component_index(
        view: *const fdb_payload_v1_view_t,
        out_component_index: *mut u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_field_count(
        view: *const fdb_payload_v1_view_t,
        out_field_count: *mut u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_field(
        view: *const fdb_payload_v1_view_t,
        field_index: u32,
        out_field: *mut *mut fdb_payload_v1_view_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_ref_target(
        view: *const fdb_payload_v1_view_t,
        out_target: *mut *mut fdb_payload_v1_view_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_graph_identity(
        view: *const fdb_payload_v1_view_t,
        out_component_index: *mut u32,
        out_object_id: *mut u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_get_bool(
        view: *const fdb_payload_v1_view_t,
        out_value: *mut u8,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_get_u8(
        view: *const fdb_payload_v1_view_t,
        out_value: *mut u8,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_get_u16(
        view: *const fdb_payload_v1_view_t,
        out_value: *mut u16,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_get_u32(
        view: *const fdb_payload_v1_view_t,
        out_value: *mut u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_get_i32(
        view: *const fdb_payload_v1_view_t,
        out_value: *mut i32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_get_u8n_f64_bits(
        view: *const fdb_payload_v1_view_t,
        out_value: *mut u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_get_u16n_f64_bits(
        view: *const fdb_payload_v1_view_t,
        out_value: *mut u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_get_f32_bits(
        view: *const fdb_payload_v1_view_t,
        out_value: *mut u32,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_get_f64_bits(
        view: *const fdb_payload_v1_view_t,
        out_value: *mut u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_acquire(
        view: *const fdb_payload_v1_view_t,
        out_access: *mut *mut fdb_payload_v1_access_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_view_materialize(
        view: *const fdb_payload_v1_view_t,
        out_materialized: *mut *mut fdb_payload_v1_view_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;

    pub fn fdb_payload_v1_access_release(access: *mut fdb_payload_v1_access_t);
    pub fn fdb_payload_v1_access_payload_bytes(
        access: *const fdb_payload_v1_access_t,
        out_data: *mut *const u8,
        out_size: *mut u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_access_str(
        access: *const fdb_payload_v1_access_t,
        out_data: *mut *const u8,
        out_size: *mut u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_access_wstr(
        access: *const fdb_payload_v1_access_t,
        out_data: *mut *const u16,
        out_size: *mut u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_access_bytes(
        access: *const fdb_payload_v1_access_t,
        out_data: *mut *const u8,
        out_size: *mut u64,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;
    pub fn fdb_payload_v1_payload_invalidate(
        payload: *mut fdb_payload_v1_payload_t,
        out_error: *mut *mut fdb_payload_v1_error_t,
    ) -> fdb_payload_v1_status_t;

    pub fn fdb_payload_v1_blob_retain(blob: *mut fdb_payload_v1_blob_t);
    pub fn fdb_payload_v1_blob_release(blob: *mut fdb_payload_v1_blob_t);
    pub fn fdb_payload_v1_blob_data(blob: *const fdb_payload_v1_blob_t) -> *const u8;
    pub fn fdb_payload_v1_blob_size(blob: *const fdb_payload_v1_blob_t) -> u64;

    pub fn fdb_payload_v1_error_retain(error: *mut fdb_payload_v1_error_t);
    pub fn fdb_payload_v1_error_release(error: *mut fdb_payload_v1_error_t);
    pub fn fdb_payload_v1_error_code(error: *const fdb_payload_v1_error_t) -> u32;
    pub fn fdb_payload_v1_error_symbol(
        error: *const fdb_payload_v1_error_t,
        out_data: *mut *const u8,
        out_size: *mut u64,
    );
    pub fn fdb_payload_v1_error_path(
        error: *const fdb_payload_v1_error_t,
        out_data: *mut *const u8,
        out_size: *mut u64,
    );
    pub fn fdb_payload_v1_error_message(
        error: *const fdb_payload_v1_error_t,
        out_data: *mut *const u8,
        out_size: *mut u64,
    );
    pub fn fdb_payload_v1_error_details_json(
        error: *const fdb_payload_v1_error_t,
        out_data: *mut *const u8,
        out_size: *mut u64,
    );
}

const _: () = {
    assert!(std::mem::size_of::<fdb_payload_v1_compile_options_t>() == 80);
    assert!(std::mem::size_of::<fdb_payload_v1_capabilities_t>() == 72);
    assert!(std::mem::size_of::<fdb_payload_v1_builder_options_t>() == 96);
    assert!(std::mem::size_of::<fdb_payload_v1_fixed_run_v1_t>() == 96);
    assert!(std::mem::size_of::<fdb_payload_v1_open_options_t>() == 112);
    assert!(std::mem::size_of::<fdb_payload_v1_plan_info_t>() == 112);
    assert!(std::mem::size_of::<fdb_payload_v1_execution_report_t>() == 72);
    assert!(std::mem::size_of::<fdb_payload_v1_codegen_options_t>() == 48);
    assert!(std::mem::size_of::<fdb_payload_v1_backing_v1_t>() == 96);
};

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn raw_prefix_layout_and_core_abi_match() {
        assert_eq!(
            size_of::<fdb_payload_v1_compile_options_t>(),
            FDB_PAYLOAD_V1_COMPILE_OPTIONS_V1_SIZE as usize
        );
        assert_eq!(
            size_of::<fdb_payload_v1_capabilities_t>(),
            FDB_PAYLOAD_V1_CAPABILITIES_V1_SIZE as usize
        );
        assert_eq!(
            size_of::<fdb_payload_v1_builder_options_t>(),
            FDB_PAYLOAD_V1_BUILDER_OPTIONS_V2_SIZE as usize
        );
        assert_eq!(
            size_of::<fdb_payload_v1_fixed_run_v1_t>(),
            FDB_PAYLOAD_V1_FIXED_RUN_V1_SIZE as usize
        );
        assert_eq!(
            size_of::<fdb_payload_v1_plan_info_t>(),
            FDB_PAYLOAD_V1_PLAN_INFO_V2_SIZE as usize
        );
        assert_eq!(
            size_of::<fdb_payload_v1_open_options_t>(),
            FDB_PAYLOAD_V1_OPEN_OPTIONS_V1_SIZE as usize
        );
        assert_eq!(
            size_of::<fdb_payload_v1_execution_report_t>(),
            FDB_PAYLOAD_V1_EXECUTION_REPORT_V1_SIZE as usize
        );
        assert_eq!(
            size_of::<fdb_payload_v1_backing_v1_t>(),
            FDB_PAYLOAD_V1_BACKING_V1_SIZE as usize
        );
        // SAFETY: this function has no arguments and returns a value.
        assert_eq!(
            unsafe { fdb_payload_v1_abi_version() },
            FDB_PAYLOAD_V1_ABI_VERSION
        );
    }
}