_fluid_fileapi_t

Struct _fluid_fileapi_t 

Source
#[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>, }
Expand description

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§

Source§

impl Clone for _fluid_fileapi_t

Source§

fn clone(&self) -> _fluid_fileapi_t

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for _fluid_fileapi_t

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for _fluid_fileapi_t

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.