Function mentat_ffi::store_begin_transaction [] [src]

#[no_mangle]
pub unsafe extern "C" fn store_begin_transaction(
    store: *mut Store
) -> *mut ExternResult

Starts a new transaction to allow multiple transacts to be performed together. This is more efficient than performing a large set of individual commits.

Returns a Result as an ExternResult.

Safety

Callers must ensure that the pointer to the Store is not dangling.

Callers are responsible for managing the memory for the return value. A destructor tx_report_destroy is provided for releasing the memory for this pointer type.

TODO: Document the errors that can result from begin_transaction