Skip to main content

read_con_file_iterator

readcon_core::ffi

Function read_con_file_iterator 

Source 
#[unsafe(no_mangle)]
pub unsafe extern "C" fn read_con_file_iterator(
    filename_c: *const c_char,
) -> *mut CConFrameIterator
Expand description

Creates a new iterator for a .con / .convel path, including transparent gzip (.con.gz) and zstd (.con.zst, requires zstd feature) inputs via crate::compression::read_file_contents.

Returns NULL if the file cannot be read, decompressed, or is not valid UTF-8. A successfully-opened file with zero frames returns a non-NULL iterator that yields NULL on the first call to con_frame_iterator_next. The caller OWNS the returned pointer and MUST call free_con_frame_iterator.

ยงSafety

filename_c must be a valid null-terminated string. The caller takes ownership of the returned iterator.