Struct emf_core_base_rs_ffi::CBaseInterface

#[repr(C)]
pub struct CBaseInterface {

    pub version: Version,
    pub base_module: Option<NonNull<CBase>>,
    pub sys_shutdown_fn: ShutdownFn,
    pub sys_panic_fn: PanicFn,
    pub sys_has_function_fn: HasFunctionFn,
    pub sys_get_function_fn: GetFunctionFn,
    pub sys_lock_fn: LockFn,
    pub sys_try_lock_fn: TryLockFn,
    pub sys_unlock_fn: UnlockFn,
    pub sys_get_sync_handler_fn: GetSyncHandlerFn,
    pub sys_set_sync_handler_fn: SetSyncHandlerFn,
    pub version_new_short_fn: NewShortFn,
    pub version_new_long_fn: NewLongFn,
    pub version_new_full_fn: NewFullFn,
    pub version_from_string_fn: FromStringFn,
    pub version_string_length_short_fn: StringLengthShortFn,
    pub version_string_length_long_fn: StringLengthLongFn,
    pub version_string_length_full_fn: StringLengthFullFn,
    pub version_as_string_short_fn: AsStringShortFn,
    pub version_as_string_long_fn: AsStringLongFn,
    pub version_as_string_full_fn: AsStringFullFn,
    pub version_string_is_valid_fn: StringIsValidFn,
    pub version_compare_fn: CompareFn,
    pub version_compare_weak_fn: CompareWeakFn,
    pub version_compare_strong_fn: CompareStrongFn,
    pub version_is_compatible_fn: IsCompatibleFn,
    pub library_register_loader_fn: RegisterLoaderFn,
    pub library_unregister_loader_fn: UnregisterLoaderFn,
    pub library_get_loader_interface_fn: GetLoaderInterfaceFn,
    pub library_get_loader_handle_from_type_fn: GetLoaderHandleFromTypeFn,
    pub library_get_loader_handle_from_library_fn: GetLoaderHandleFromLibraryFn,
    pub library_get_num_loaders_fn: GetNumLoadersFn,
    pub library_library_exists_fn: LibraryExistsFn,
    pub library_type_exists_fn: TypeExistsFn,
    pub library_get_library_types_fn: GetLibraryTypesFn,
    pub library_create_library_handle_fn: CreateLibraryHandleFn,
    pub library_remove_library_handle_fn: RemoveLibraryHandleFn,
    pub library_link_library_fn: LinkLibraryFn,
    pub library_get_internal_library_handle_fn: GetInternalLibraryHandleFn,
    pub library_load_fn: LoadFn,
    pub library_unload_fn: UnloadFn,
    pub library_get_data_symbol_fn: GetDataSymbolFn,
    pub library_get_function_symbol_fn: GetFunctionSymbolFn,
    pub module_register_loader_fn: RegisterLoaderFn,
    pub module_unregister_loader_fn: UnregisterLoaderFn,
    pub module_get_loader_interface_fn: GetLoaderInterfaceFn,
    pub module_get_loader_handle_from_type_fn: GetLoaderHandleFromTypeFn,
    pub module_get_loader_handle_from_module_fn: GetLoaderHandleFromModuleFn,
    pub module_get_num_modules_fn: GetNumModulesFn,
    pub module_get_num_loaders_fn: GetNumLoadersFn,
    pub module_get_num_exported_interfaces_fn: GetNumExportedInterfacesFn,
    pub module_module_exists_fn: ModuleExistsFn,
    pub module_type_exists_fn: TypeExistsFn,
    pub module_exported_interface_exists_fn: ExportedInterfaceExistsFn,
    pub module_get_modules_fn: GetModulesFn,
    pub module_get_module_types_fn: GetModuleTypesFn,
    pub module_get_exported_interfaces_fn: GetExportedInterfacesFn,
    pub module_get_exported_interface_handle_fn: GetExportedInterfaceHandleFn,
    pub module_create_module_handle_fn: CreateModuleHandleFn,
    pub module_remove_module_handle_fn: RemoveModuleHandleFn,
    pub module_link_module_fn: LinkModuleFn,
    pub module_get_internal_module_handle_fn: GetInternalModuleHandleFn,
    pub module_add_module_fn: AddModuleFn,
    pub module_remove_module_fn: RemoveModuleFn,
    pub module_load_fn: LoadFn,
    pub module_unload_fn: UnloadFn,
    pub module_initialize_fn: InitializeFn,
    pub module_terminate_fn: TerminateFn,
    pub module_add_dependency_fn: AddDependencyFn,
    pub module_remove_dependency_fn: RemoveDependencyFn,
    pub module_export_interface_fn: ExportInterfaceFn,
    pub module_get_load_dependencies_fn: GetLoadDependenciesFn,
    pub module_get_runtime_dependencies_fn: GetRuntimeDependenciesFn,
    pub module_get_exportable_interfaces_fn: GetExportableInterfacesFn,
    pub module_fetch_status_fn: FetchStatusFn,
    pub module_get_module_path_fn: GetModulePathFn,
    pub module_get_module_info_fn: GetModuleInfoFn,
    pub module_get_interface_fn: GetInterfaceFn,
}

emf-core-base interface.

Fields

version: Version

base_module: Option<NonNull<CBase>>

sys_shutdown_fn: ShutdownFn

sys_panic_fn: PanicFn

sys_has_function_fn: HasFunctionFn

sys_get_function_fn: GetFunctionFn

sys_lock_fn: LockFn

sys_try_lock_fn: TryLockFn

sys_unlock_fn: UnlockFn

sys_get_sync_handler_fn: GetSyncHandlerFn

sys_set_sync_handler_fn: SetSyncHandlerFn

version_new_short_fn: NewShortFn

version_new_long_fn: NewLongFn

version_new_full_fn: NewFullFn

version_from_string_fn: FromStringFn

version_string_length_short_fn: StringLengthShortFn

version_string_length_long_fn: StringLengthLongFn

version_string_length_full_fn: StringLengthFullFn

version_as_string_short_fn: AsStringShortFn

version_as_string_long_fn: AsStringLongFn

version_as_string_full_fn: AsStringFullFn

version_string_is_valid_fn: StringIsValidFn

version_compare_fn: CompareFn

version_compare_weak_fn: CompareWeakFn

version_compare_strong_fn: CompareStrongFn

version_is_compatible_fn: IsCompatibleFn

library_register_loader_fn: RegisterLoaderFn

library_unregister_loader_fn: UnregisterLoaderFn

library_get_loader_interface_fn: GetLoaderInterfaceFn

library_get_loader_handle_from_type_fn: GetLoaderHandleFromTypeFn

library_get_loader_handle_from_library_fn: GetLoaderHandleFromLibraryFn

library_get_num_loaders_fn: GetNumLoadersFn

library_library_exists_fn: LibraryExistsFn

library_type_exists_fn: TypeExistsFn

library_get_library_types_fn: GetLibraryTypesFn

library_create_library_handle_fn: CreateLibraryHandleFn

library_remove_library_handle_fn: RemoveLibraryHandleFn

library_link_library_fn: LinkLibraryFn

library_get_internal_library_handle_fn: GetInternalLibraryHandleFn

library_load_fn: LoadFn

library_unload_fn: UnloadFn

library_get_data_symbol_fn: GetDataSymbolFn

library_get_function_symbol_fn: GetFunctionSymbolFn

module_register_loader_fn: RegisterLoaderFn

module_unregister_loader_fn: UnregisterLoaderFn

module_get_loader_interface_fn: GetLoaderInterfaceFn

module_get_loader_handle_from_type_fn: GetLoaderHandleFromTypeFn

module_get_loader_handle_from_module_fn: GetLoaderHandleFromModuleFn

module_get_num_modules_fn: GetNumModulesFn

module_get_num_loaders_fn: GetNumLoadersFn

module_get_num_exported_interfaces_fn: GetNumExportedInterfacesFn

module_module_exists_fn: ModuleExistsFn

module_type_exists_fn: TypeExistsFn

module_exported_interface_exists_fn: ExportedInterfaceExistsFn

module_get_modules_fn: GetModulesFn

module_get_module_types_fn: GetModuleTypesFn

module_get_exported_interfaces_fn: GetExportedInterfacesFn

module_get_exported_interface_handle_fn: GetExportedInterfaceHandleFn

module_create_module_handle_fn: CreateModuleHandleFn

module_remove_module_handle_fn: RemoveModuleHandleFn

module_link_module_fn: LinkModuleFn

module_get_internal_module_handle_fn: GetInternalModuleHandleFn

module_add_module_fn: AddModuleFn

module_remove_module_fn: RemoveModuleFn

module_load_fn: LoadFn

module_unload_fn: UnloadFn

module_initialize_fn: InitializeFn

module_terminate_fn: TerminateFn

module_add_dependency_fn: AddDependencyFn

module_remove_dependency_fn: RemoveDependencyFn

module_export_interface_fn: ExportInterfaceFn

module_get_load_dependencies_fn: GetLoadDependenciesFn

module_get_runtime_dependencies_fn: GetRuntimeDependenciesFn

module_get_exportable_interfaces_fn: GetExportableInterfacesFn

module_fetch_status_fn: FetchStatusFn

module_get_module_path_fn: GetModulePathFn

module_get_module_info_fn: GetModuleInfoFn

module_get_interface_fn: GetInterfaceFn

Trait Implementations

impl CBaseBinding for CBaseInterface

fn interface_version(&self) -> Version

Returns the version of the interface.

fn base_module(&self) -> Option<NonNull<CBase>>

Returns a handle to the interface.

fn fetch_has_function_fn(&self) -> HasFunctionFn

Returns a fn pointer to the has_function fn.

fn fetch_get_function_fn(&self) -> GetFunctionFn

Returns a fn pointer to the get_function fn.

impl Clone for CBaseInterface

fn clone(&self) -> CBaseInterface

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CBaseInterface

impl Debug for CBaseInterface

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

Formats the value using the given formatter.

impl Eq for CBaseInterface

impl LibraryBinding for CBaseInterface

unsafe fn register_loader(
    &mut self,
    loader: NonNullConst<LibraryLoaderInterface>,
    lib_type: NonNullConst<LibraryType>
) -> Result<LoaderHandle, Error>

Registers a new loader.

unsafe fn unregister_loader(
    &mut self,
    handle: LoaderHandle
) -> Result<i8, Error>

Unregisters an existing loader.

unsafe fn get_loader_interface(
    &mut self,
    handle: LoaderHandle
) -> Result<NonNullConst<LibraryLoaderInterface>, Error>

Fetches the interface of a library loader.

unsafe fn get_loader_handle_from_type(
    &self,
    lib_type: NonNullConst<LibraryType>
) -> Result<LoaderHandle, Error>

Fetches the loader handle associated with the library type.

unsafe fn get_loader_handle_from_library(
    &self,
    handle: LibraryHandle
) -> Result<LoaderHandle, Error>

Fetches the loader handle linked with the library handle.

unsafe fn get_num_loaders(&self) -> usize

Fetches the number of registered loaders.

unsafe fn library_exists(&self, handle: LibraryHandle) -> Bool

Checks if a the library handle is valid.

unsafe fn type_exists(&self, lib_type: NonNullConst<LibraryType>) -> Bool

Checks if a library type exists.

unsafe fn get_library_types(
    &self,
    buffer: NonNull<MutSpan<LibraryType>>
) -> Result<usize, Error>

Copies the strings of the registered library types into a buffer.

unsafe fn create_library_handle(&mut self) -> LibraryHandle

Creates a new unlinked library handle.

unsafe fn remove_library_handle(
    &mut self,
    handle: LibraryHandle
) -> Result<i8, Error>

Removes an existing library handle.

unsafe fn link_library(
    &mut self,
    handle: LibraryHandle,
    loader: LoaderHandle,
    internal: InternalHandle
) -> Result<i8, Error>

Links a library handle to an internal library handle.

unsafe fn get_internal_library_handle(
    &self,
    handle: LibraryHandle
) -> Result<InternalHandle, Error>

Fetches the internal handle linked with the library handle.

unsafe fn load(
    &mut self,
    loader: LoaderHandle,
    path: NonNullConst<OSPathChar>
) -> Result<LibraryHandle, Error>

Loads a library. The resulting handle is unique.

unsafe fn unload(&mut self, handle: LibraryHandle) -> Result<i8, Error>

Unloads a library.

unsafe fn get_data_symbol(
    &self,
    handle: LibraryHandle,
    symbol: NonNullConst<u8>
) -> Result<Symbol<NonNullConst<c_void>>, Error>

Fetches a data symbol from a library.

unsafe fn get_function_symbol(
    &self,
    handle: LibraryHandle,
    symbol: NonNullConst<u8>
) -> Result<Symbol<CBaseFn>, Error>

Fetches a function symbol from a library.

impl ModuleBinding for CBaseInterface

unsafe fn register_loader(
    &mut self,
    loader: NonNullConst<ModuleLoaderInterface>,
    mod_type: NonNullConst<ModuleType>
) -> Result<LoaderHandle, Error>

Registers a new module loader.

unsafe fn unregister_loader(
    &mut self,
    loader: LoaderHandle
) -> Result<i8, Error>

Unregisters an existing module loader.

unsafe fn get_loader_interface(
    &mut self,
    loader: LoaderHandle
) -> Result<NonNullConst<ModuleLoaderInterface>, Error>

Fetches the interface of a module loader.

unsafe fn get_loader_handle_from_type(
    &self,
    mod_type: NonNullConst<ModuleType>
) -> Result<LoaderHandle, Error>

Fetches the handle of the loader associated with a module type.

unsafe fn get_loader_handle_from_module(
    &self,
    handle: ModuleHandle
) -> Result<LoaderHandle, Error>

Fetches the handle of the loader linked with the module handle.

unsafe fn get_num_modules(&self) -> usize

Fetches the number of loaded modules.

unsafe fn get_num_loaders(&self) -> usize

Fetches the number of loaders.

unsafe fn get_num_exported_interfaces(&self) -> usize

Fetches the number of exported interfaces.

unsafe fn module_exists(&self, handle: ModuleHandle) -> Bool

Checks if a module exists.

unsafe fn type_exists(&self, mod_type: NonNullConst<ModuleType>) -> Bool

Checks if a module type exists.

unsafe fn exported_interface_exists(
    &self,
    interface: NonNullConst<InterfaceDescriptor>
) -> Bool

Checks whether an exported interface exists.

unsafe fn get_modules(
    &self,
    buffer: NonNull<MutSpan<ModuleInfo>>
) -> Result<usize, Error>

Copies the available module info into a buffer.

unsafe fn get_module_types(
    &self,
    buffer: NonNull<MutSpan<ModuleType>>
) -> Result<usize, Error>

Copies the available module types into a buffer.

unsafe fn get_exported_interfaces(
    &self,
    buffer: NonNull<MutSpan<InterfaceDescriptor>>
) -> Result<usize, Error>

Copies the descriptors of the exported interfaces into a buffer.

unsafe fn get_exported_interface_handle(
    &self,
    interface: NonNullConst<InterfaceDescriptor>
) -> Result<ModuleHandle, Error>

Fetches the module handle of the exported interface.

unsafe fn create_module_handle(&mut self) -> ModuleHandle

Creates a new unlinked module handle.

unsafe fn remove_module_handle(
    &mut self,
    handle: ModuleHandle
) -> Result<i8, Error>

Removes an existing module handle.

unsafe fn link_module(
    &mut self,
    handle: ModuleHandle,
    loader: LoaderHandle,
    internal: InternalHandle
) -> Result<i8, Error>

Links a module handle to an internal module handle.

unsafe fn get_internal_module_handle(
    &self,
    handle: ModuleHandle
) -> Result<InternalHandle, Error>

Fetches the internal handle linked with the module handle.

unsafe fn add_module(
    &mut self,
    loader: LoaderHandle,
    path: NonNullConst<OSPathChar>
) -> Result<ModuleHandle, Error>

Adds a new module.

unsafe fn remove_module(&mut self, handle: ModuleHandle) -> Result<i8, Error>

Removes a module.

unsafe fn load(&mut self, handle: ModuleHandle) -> Result<i8, Error>

Loads a module.

unsafe fn unload(&mut self, handle: ModuleHandle) -> Result<i8, Error>

Unloads a module.

unsafe fn initialize(&mut self, handle: ModuleHandle) -> Result<i8, Error>

Initializes a module.

unsafe fn terminate(&mut self, handle: ModuleHandle) -> Result<i8, Error>

Terminates a module.

unsafe fn add_dependency(
    &mut self,
    handle: ModuleHandle,
    interface: NonNullConst<InterfaceDescriptor>
) -> Result<i8, Error>

Registers a new runtime dependency of the module.

unsafe fn remove_dependency(
    &mut self,
    handle: ModuleHandle,
    interface: NonNullConst<InterfaceDescriptor>
) -> Result<i8, Error>

Removes an existing runtime dependency from the module.

unsafe fn export_interface(
    &mut self,
    handle: ModuleHandle,
    interface: NonNullConst<InterfaceDescriptor>
) -> Result<i8, Error>

Exports an interface of a module.

unsafe fn get_load_dependencies(
    &self,
    handle: ModuleHandle
) -> Result<ConstSpan<InterfaceDescriptor>, Error>

Fetches the load dependencies of a module.

unsafe fn get_runtime_dependencies(
    &self,
    handle: ModuleHandle
) -> Result<ConstSpan<InterfaceDescriptor>, Error>

Fetches the runtime dependencies of a module.

unsafe fn get_exportable_interfaces(
    &self,
    handle: ModuleHandle
) -> Result<ConstSpan<InterfaceDescriptor>, Error>

Fetches the exportable interfaces of a module.

unsafe fn fetch_status(
    &self,
    handle: ModuleHandle
) -> Result<ModuleStatus, Error>

Fetches the load status of a module.

unsafe fn get_module_path(
    &self,
    handle: ModuleHandle
) -> Result<NonNullConst<OSPathChar>, Error>

Fetches the path a module was loaded from.

unsafe fn get_module_info(
    &self,
    handle: ModuleHandle
) -> Result<NonNullConst<ModuleInfo>, Error>

Fetches the module info from a module.

unsafe fn get_interface(
    &self,
    handle: ModuleHandle,
    interface: NonNullConst<InterfaceDescriptor>
) -> Result<Interface, Error>

Fetches an interface from a module.

impl Ord for CBaseInterface

fn cmp(&self, other: &CBaseInterface) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<CBaseInterface> for CBaseInterface

fn eq(&self, other: &CBaseInterface) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CBaseInterface) -> bool

This method tests for !=.

impl PartialOrd<CBaseInterface> for CBaseInterface

fn partial_cmp(&self, other: &CBaseInterface) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Send for CBaseInterface

impl StructuralEq for CBaseInterface

impl StructuralPartialEq for CBaseInterface

impl Sync for CBaseInterface

impl SysBinding for CBaseInterface

unsafe fn shutdown(&mut self) -> !

Sends a termination signal.

unsafe fn panic(&self, error: Option<NonNullConst<u8>>) -> !

Execution of the program is stopped abruptly. The error may be logged.

unsafe fn has_function(&self, id: FnId) -> Bool

Checks if a function is implemented.

unsafe fn get_function(&self, id: FnId) -> Optional<CBaseFn>

Fetches a function from the interface.

unsafe fn lock(&self)

Locks the interface.

unsafe fn try_lock(&self) -> Bool

Tries to lock the interface.

unsafe fn unlock(&self)

Unlocks the interface.

unsafe fn get_sync_handler(&self) -> NonNullConst<SyncHandlerInterface>

Fetches the active synchronization handler.

unsafe fn set_sync_handler(
    &mut self,
    handler: Option<NonNullConst<SyncHandlerInterface>>
)

Sets a new synchronization handler.

impl VersionBinding for CBaseInterface

unsafe fn new_short(&self, major: i32, minor: i32, patch: i32) -> Version

Constructs a new version.

unsafe fn new_long(
    &self,
    major: i32,
    minor: i32,
    patch: i32,
    release_type: ReleaseType,
    release_number: i8
) -> Version

Constructs a new version.

unsafe fn new_full(
    &self,
    major: i32,
    minor: i32,
    patch: i32,
    release_type: ReleaseType,
    release_number: i8,
    build: i64
) -> Version

Constructs a new version.

unsafe fn from_string(
    &self,
    buffer: NonNullConst<ConstSpan<u8>>
) -> Result<Version, Error>

Constructs a version from a string.

unsafe fn string_length_short(&self, version: NonNullConst<Version>) -> usize

Computes the length of the short version string.

unsafe fn string_length_long(&self, version: NonNullConst<Version>) -> usize

Computes the length of the long version string.

unsafe fn string_length_full(&self, version: NonNullConst<Version>) -> usize

Computes the length of the full version string.

unsafe fn as_string_short(
    &self,
    version: NonNullConst<Version>,
    buffer: NonNull<MutSpan<u8>>
) -> Result<usize, Error>

Represents the version as a short string.

unsafe fn as_string_long(
    &self,
    version: NonNullConst<Version>,
    buffer: NonNull<MutSpan<u8>>
) -> Result<usize, Error>

Represents the version as a long string.

unsafe fn as_string_full(
    &self,
    version: NonNullConst<Version>,
    buffer: NonNull<MutSpan<u8>>
) -> Result<usize, Error>

Represents the version as a full string.

unsafe fn string_is_valid(
    &self,
    version_string: NonNullConst<ConstSpan<u8>>
) -> Bool

Checks whether the version string is valid.

unsafe fn compare(
    &self,
    lhs: NonNullConst<Version>,
    rhs: NonNullConst<Version>
) -> i32

Compares two versions.

unsafe fn compare_weak(
    &self,
    lhs: NonNullConst<Version>,
    rhs: NonNullConst<Version>
) -> i32

Compares two versions.

unsafe fn compare_strong(
    &self,
    lhs: NonNullConst<Version>,
    rhs: NonNullConst<Version>
) -> i32

Compares two versions.

unsafe fn is_compatible(
    &self,
    lhs: NonNullConst<Version>,
    rhs: NonNullConst<Version>
) -> Bool

Checks for compatibility of two versions.