Struct fluidlite_sys::_fluid_fileapi_t

#[repr(C)]
pub struct _fluid_fileapi_t {
    pub data: *mut c_void,
    pub free: Option<unsafe extern "C" fn(fileapi: *mut fluid_fileapi_t) -> c_int>,
    pub fopen: Option<unsafe extern "C" fn(fileapi: *mut fluid_fileapi_t, filename: *const c_char) -> *mut c_void>,
    pub fread: Option<unsafe extern "C" fn(buf: *mut c_void, count: c_int, handle: *mut c_void) -> c_int>,
    pub fseek: Option<unsafe extern "C" fn(handle: *mut c_void, offset: c_long, origin: c_int) -> c_int>,
    pub fclose: Option<unsafe extern "C" fn(handle: *mut c_void) -> c_int>,
    pub ftell: Option<unsafe extern "C" fn(handle: *mut c_void) -> c_long>,
}

File callback structure to enable custom soundfont loading (e.g. from memory).

Fields

data: *mut c_void

Private data

free: Option<unsafe extern "C" fn(fileapi: *mut fluid_fileapi_t) -> c_int>

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(fileapi: *mut fluid_fileapi_t, filename: *const c_char) -> *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(buf: *mut c_void, count: c_int, handle: *mut c_void) -> c_int>

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(handle: *mut c_void, offset: c_long, origin: c_int) -> c_int>

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(handle: *mut c_void) -> c_int>

Closes the handle and frees used ressources.

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

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

@return returns current file offset or #FLUID_FAILED on error

Trait Implementations

impl Clone for _fluid_fileapi_t

fn clone(&self) -> _fluid_fileapi_t

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for _fluid_fileapi_t

impl Debug for _fluid_fileapi_t

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.