Struct PluginModuleRef 

#[repr(transparent)]
pub struct PluginModuleRef(pub PrefixRef<PluginModule_Prefix>);

This is the pointer to the prefix of PluginModule.

This is automatically generated documentation,by the StableAbi derive macro.

Creating a compiletime-constant

You can look at the docs in ::abi_stable::docs::prefix_types to see how you can construct and use this and similar types.
More specifically in the “constructing a module” example or the “Constructing a vtable” example

Tuple Fields

0: PrefixRef<PluginModule_Prefix>

Implementations

impl PluginModuleRef

pub fn init( &self, ) -> extern "C" fn(logging: PluginLogging) -> RResult<PluginRuntimeConfiguration, PluginInitializationError>

Accessor method for the PluginModule::init field.This is for a field which always exists.

pub fn create( &self, ) -> extern "C" fn(plugin_id: RString, input_schema: ROption<SafeArrowSchema>, options: PluginOptions, runtime: PluginAsyncRuntimeObj, state_backend_config: PluginStateBackendConfig, message_channels: PluginChannels) -> RResult<PluginResult, PluginInitializationError>

Accessor method for the PluginModule::create field.This is for a field which always exists.

impl PluginModuleRef

pub fn _prefix_type_layout(self) -> &'static PTStructLayout

Accessor to get the layout of the type,used for error messages.

pub fn udf_descriptors( &self, ) -> Option<extern "C" fn() -> RResult<RVec<PluginUdfDescriptor>, PluginInitializationError>>

Accessor method for the PluginModule::udf_descriptors field.Returns Some(field_value) if the field exists,None if it does not.

pub fn side_output_descriptors( &self, ) -> Option<extern "C" fn() -> RResult<RVec<PluginSideOutputDescriptor>, PluginInitializationError>>

Accessor method for the PluginModule::side_output_descriptors field.Returns Some(field_value) if the field exists,None if it does not.

Trait Implementations

impl Clone for PluginModuleRef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PluginModuleRef

impl GetPointerKind for PluginModuleRef

type PtrTarget = WithMetadata_<PluginModule_Prefix, PluginModule_Prefix>

What this pointer points to.

type Kind = PK_Reference

The kind of the pointer.

const KIND: PointerKind = <Self::Kind as PointerKindVariant>::VALUE

The value-level version of the Kind associated type.

impl GetStaticEquivalent_ for PluginModuleRef

where PluginModule: PrefixTypeTrait,

type StaticEquivalent = PrefixRef<_static_PluginModule>

The 'static equivalent of Self

impl PrefixRefTrait for PluginModuleRef

type PrefixFields = PluginModule_Prefix

A struct that contains all the fields of some other struct up to the field annotated with #[sabi(last_prefix_field)] inclusive.

fn from_prefix_ref(this: PrefixRef<Self::PrefixFields>) -> Self

Converts a PrefixRef to Self

fn to_prefix_ref(self) -> PrefixRef<Self::PrefixFields>

Converts Self to a PrefixRef

impl RootModule for PluginModuleRef

const BASE_NAME: &'static str = "streamling_plugin"

The name of the dynamic library,which is the same on all platforms. This is generally the name of the implementation crate.

const NAME: &'static str = "streamling_plugin"

The name of the library used in error messages.

const VERSION_STRINGS: VersionStrings

The version number of the library that this is a root module of.

fn root_module_statics() -> &'static RootModuleStatics<PluginModuleRef>

Gets the statics for Self.

fn initialization(self) -> Result<Self, LibraryError>

Defines behavior that happens once the module is loaded.

const CONSTANTS: RootModuleConsts = _

All the constants of this trait and supertraits.

const CONSTANTS_NO_ABI_INFO: RootModuleConsts = _

Like Self::CONSTANTS, except without including the type layout constant for the root module.

fn get_module() -> Option<Self>

Gets the root module,returning None if the module is not yet loaded.

fn get_raw_library() -> Option<&'static RawLibrary>

Gets the RawLibrary of the module, returning None if the dynamic library failed to load (it doesn’t exist or layout checking failed).

fn get_library_path(directory: &Path) -> PathBuf

Returns the path the library would be loaded from,given a directory(folder).

fn load_module_with<F, E>(f: F) -> Result<Self, E>

where F: FnOnce() -> Result<Self, E>,

Loads the root module,with a closure which either returns the root module or an error.

fn load_from(where_: LibraryPath<'_>) -> Result<Self, LibraryError>

Loads this module from the path specified by where_, first loading the dynamic library if it wasn’t already loaded.

fn load_from_directory(where_: &Path) -> Result<Self, LibraryError>

Loads this module from the directory specified by where_, first loading the dynamic library if it wasn’t already loaded.

fn load_from_file(path_: &Path) -> Result<Self, LibraryError>

Loads this module from the file at path_, first loading the dynamic library if it wasn’t already loaded.

impl StableAbi for PluginModuleRef

where PluginModule: PrefixTypeTrait,

const LAYOUT: &'static TypeLayout = <__sabi_re::PrefixRef<PluginModule_Prefix> as __sabi_re::StableAbi>::LAYOUT

The layout of the type provided by implementors.

type IsNonZeroType = True

Whether this type has a single invalid bit-pattern.

const ABI_CONSTS: AbiConsts = _

const-equivalents of the associated types.