Skip to main content

PluginInstance

Struct PluginInstance 

Source
pub struct PluginInstance { /* private fields */ }
Expand description

A WASM plugin instance ready for execution.

Implementations§

Source§

impl PluginInstance

Source

pub fn new( engine: &Engine, module: &CompiledModule, limits: PluginLimits, ) -> Result<Self, WasmError>

Create a new plugin instance from a compiled module.

Source

pub fn new_with_http_client( engine: &Engine, module: &CompiledModule, limits: PluginLimits, http_client: Option<Arc<HttpClient>>, ) -> Result<Self, WasmError>

Create a new plugin instance with an HTTP client for outbound calls.

Source

pub fn new_with_options( engine: &Engine, module: &CompiledModule, limits: PluginLimits, http_client: Option<Arc<HttpClient>>, secrets: Option<SecretsStore>, ) -> Result<Self, WasmError>

Create a new plugin instance with HTTP client and secrets.

Source

pub fn new_with_all_options( engine: &Engine, module: &CompiledModule, limits: PluginLimits, http_client: Option<Arc<HttpClient>>, secrets: Option<SecretsStore>, rate_limiter: Option<RateLimiter>, response_cache: Option<ResponseCache>, nats_publisher: Option<Arc<NatsPublisher>>, kafka_publisher: Option<Arc<KafkaPublisher>>, ) -> Result<Self, WasmError>

Create a new plugin instance with all options including rate limiter and cache.

Source

pub fn name(&self) -> &str

Get the plugin name.

Source

pub fn write_to_memory(&mut self, data: &[u8]) -> Result<i32, WasmError>

Write data to the plugin’s linear memory and return the pointer.

Uses the plugin’s exported alloc function so that dlmalloc is aware of the allocation and will not reuse the region during deserialization. Falls back to growing memory directly for legacy plugins that lack the alloc export (only safe for very small payloads like config JSON).

Source

pub fn init(&mut self, config_json: &[u8]) -> Result<i32, WasmError>

Call the init function with the given config.

Source

pub fn on_request(&mut self, request_json: &[u8]) -> Result<i32, WasmError>

Call on_request with the given request data.

Source

pub fn on_response(&mut self, response_json: &[u8]) -> Result<i32, WasmError>

Call on_response with the given response data.

Source

pub fn dispatch(&mut self, request_json: &[u8]) -> Result<i32, WasmError>

Call dispatch with the given request data.

Source

pub fn take_output(&mut self) -> Vec<u8>

Get the output buffer contents.

Source

pub fn set_context(&mut self, context: RequestContext)

Set the request context for the next call.

Source

pub fn get_context(&self) -> RequestContext

Get the current request context (after modifications by host functions).

Source

pub fn take_last_http_result(&mut self) -> Option<Vec<u8>>

Take the last HTTP result buffer (from host_http_call or host_http_stream).

Returns None if no HTTP call was made or the result was already taken.

Source

pub fn set_stream_sender(&mut self, sender: Arc<UnboundedSender<StreamEvent>>)

Inject a stream sender for host_http_stream before calling dispatch.

The sender is wrapped in an Arc so host functions can clone it for use inside std::thread::scope without lifetime conflicts.

Source

pub fn take_ws_upgrade_request(&mut self) -> Option<WsUpgradeRequest>

Take the upstream WebSocket upgrade request from host_ws_upgrade (ADR-0026).

Returns None if no WebSocket upgrade was requested or the request was already taken.

Source

pub fn set_request_body(&mut self, body: Option<Vec<u8>>)

Set the request/response body for the next handler call (side-channel).

Source

pub fn take_output_body(&mut self) -> Option<Option<Vec<u8>>>

Take the output body set by the plugin via host_body_set/host_body_clear.

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

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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