CNativePluginAPI

Struct CNativePluginAPI 

Source
#[repr(C)]
pub struct CNativePluginAPI { pub version: u32, pub get_metadata: extern "C" fn() -> *const CNodeMetadata, pub create_instance: extern "C" fn(*const c_char, CLogCallback, *mut c_void) -> CPluginHandle, pub process_packet: extern "C" fn(CPluginHandle, *const c_char, *const CPacket, COutputCallback, *mut c_void, CTelemetryCallback, *mut c_void) -> CResult, pub update_params: extern "C" fn(CPluginHandle, *const c_char) -> CResult, pub flush: extern "C" fn(CPluginHandle, COutputCallback, *mut c_void, CTelemetryCallback, *mut c_void) -> CResult, pub destroy_instance: extern "C" fn(CPluginHandle), }
Expand description

The main plugin API structure Plugins export a function that returns a pointer to this struct

Fields§

§version: u32

API version for compatibility checking

§get_metadata: extern "C" fn() -> *const CNodeMetadata

Get metadata about the node type Returns: Pointer to CNodeMetadata (must remain valid for plugin lifetime)

§create_instance: extern "C" fn(*const c_char, CLogCallback, *mut c_void) -> CPluginHandle

Create a new plugin instance params: JSON string with initialization parameters (nullable) log_callback: Callback for plugin to send log messages to host log_user_data: Opaque pointer to pass to log callback Returns: Opaque handle to the instance, or null on error

§process_packet: extern "C" fn(CPluginHandle, *const c_char, *const CPacket, COutputCallback, *mut c_void, CTelemetryCallback, *mut c_void) -> CResult

Process an incoming packet handle: Plugin instance handle input_pin: Name of the input pin packet: The packet to process output_callback: Callback to send output packets callback_data: User data to pass to output callback telemetry_callback: Callback to emit telemetry events telemetry_user_data: User data to pass to telemetry callback

§update_params: extern "C" fn(CPluginHandle, *const c_char) -> CResult

Update runtime parameters handle: Plugin instance handle params: JSON string with new parameters (nullable)

§flush: extern "C" fn(CPluginHandle, COutputCallback, *mut c_void, CTelemetryCallback, *mut c_void) -> CResult

Flush any buffered data (called when input stream ends) handle: Plugin instance handle output_callback: Callback to send output packets callback_data: User data to pass to output callback telemetry_callback: Callback to emit telemetry events telemetry_user_data: User data to pass to telemetry callback

§destroy_instance: extern "C" fn(CPluginHandle)

Destroy a plugin instance handle: Plugin instance handle

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more