Skip to main content

Module ffi

Module ffi 

Source

Structs§

CAtom
CConFrameIterator
CFrame
A transparent, “lossy” C-struct containing only the core atomic data. This can be extracted from an RKRConFrame handle for direct data access. The caller is responsible for freeing the atoms array using free_c_frame.
RKRConFrame
An opaque handle to a full, lossless Rust ConFrame object. The C/C++ side needs to treat this as a void pointer
RKRConFrameWriter
An opaque handle to a Rust ConFrameWriter object. The C/C++ side needs to treat this as a void pointer

Functions§

con_frame_iterator_next
Reads the next frame from the iterator, returning an opaque handle. The caller OWNS the returned handle and must free it with free_rkr_frame.
create_writer_from_path_c
Creates a new frame writer for the specified file. The caller OWNS the returned pointer and MUST call free_rkr_writer.
free_c_frame
Frees the memory of a CFrame struct, including its internal atoms array.
free_con_frame_iterator
Frees the memory for a CConFrameIterator.
free_rkr_frame
Frees the memory for an opaque RKRConFrame handle.
free_rkr_writer
Frees the memory for an RKRConFrameWriter, closing the associated file.
read_con_file_iterator
Creates a new iterator for a .con file. The caller OWNS the returned pointer and MUST call free_con_frame_iterator. Returns NULL if there are no more frames or on error.
rkr_frame_get_header_line
Copies a header string line into a user-provided buffer. This is a C style helper… where the user explicitly sets the buffer. Returns the number of bytes written (excluding null terminator), or -1 on error.
rkr_frame_get_header_line_cpp
Gets a header string line as a newly allocated, null-terminated C string.
rkr_frame_to_c_frame
Extracts the core atomic data into a transparent CFrame struct. The caller OWNS the returned pointer and MUST call free_c_frame on it.
rkr_free_string
Frees a C string that was allocated by Rust (e.g., from rkr_frame_get_header_line).
rkr_writer_extend
Writes multiple frames from an array of handles to the file managed by the writer.