fluid_fileapi_t

Type Alias fluid_fileapi_t 

Source
pub type fluid_fileapi_t = _fluid_fileapi_t;

Aliased Type§

#[repr(C)]
pub struct fluid_fileapi_t { pub data: *mut c_void, pub free: Option<unsafe extern "C" fn(*mut _fluid_fileapi_t) -> i32>, pub fopen: Option<unsafe extern "C" fn(*mut _fluid_fileapi_t, *const i8) -> *mut c_void>, pub fread: Option<unsafe extern "C" fn(*mut c_void, i32, *mut c_void) -> i32>, pub fseek: Option<unsafe extern "C" fn(*mut c_void, i64, i32) -> i32>, pub fclose: Option<unsafe extern "C" fn(*mut c_void) -> i32>, pub ftell: Option<unsafe extern "C" fn(*mut c_void) -> i64>, }

Fields§

§data: *mut c_void

Private data

§free: Option<unsafe extern "C" fn(*mut _fluid_fileapi_t) -> i32>

The free must free the memory allocated for the loader in addition to any private data. It should return 0 if no error occured, non-zero otherwise.

§fopen: Option<unsafe extern "C" fn(*mut _fluid_fileapi_t, *const i8) -> *mut c_void>

Opens the file or memory indicated by \c filename in binary read mode. \c filename matches the one provided during the fluid_synth_sfload() call.

@return returns a file handle on success, NULL otherwise

§fread: Option<unsafe extern "C" fn(*mut c_void, i32, *mut c_void) -> i32>

Reads \c count bytes to the specified buffer \c buf.

@return returns #FLUID_OK if exactly \c count bytes were successfully read, else #FLUID_FAILED

§fseek: Option<unsafe extern "C" fn(*mut c_void, i64, i32) -> i32>

Same purpose and behaviour as fseek.

@param origin either \c SEEK_SET, \c SEEK_CUR or \c SEEK_END

@return returns #FLUID_OK if the seek was successfully performed while not seeking beyond a buffer or file, #FLUID_FAILED otherwise

§fclose: Option<unsafe extern "C" fn(*mut c_void) -> i32>

Closes the handle and frees used ressources.

@return returns #FLUID_OK on success, #FLUID_FAILED on error

§ftell: Option<unsafe extern "C" fn(*mut c_void) -> i64>

@return returns current file offset or #FLUID_FAILED on error