Struct WasmLayer 

pub struct WasmLayer { /* private fields */ }

Available on crate feature wasm-plugins only.

WebAssembly middleware. See the module docs.

Implementations

impl WasmLayer

pub fn new(name: impl Into<String>, wasm: &[u8]) -> Result<WasmLayer, String>

Compile wasm (binary module bytes) as plugin name. Refused: a module that imports anything, or lacks memory, rws_alloc or rws_on_request of the right types.

pub fn from_file(path: &str) -> Result<WasmLayer, String>

Self::new from a .wasm file; the plugin is named after it.

pub fn fuel(self, fuel: u64) -> WasmLayer

Fuel per hook call (default DEFAULT_FUEL).

pub fn memory_mb(self, mb: u64) -> WasmLayer

Linear memory limit in MiB (default DEFAULT_MEMORY_MB).

pub fn config(self, config: impl Into<String>) -> WasmLayer

The string rws_init gets.

pub fn name(&self) -> &str

pub fn on_request( &self, request: &Request, connection: &ConnectionInfo, ) -> Result<RequestAction, PluginError>

Run the request hook on its own (for tests and embedders).

Trait Implementations

impl Clone for WasmLayer

fn clone(&self) -> WasmLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WasmLayer

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

Formats the value using the given formatter.

impl Middleware for WasmLayer

fn accepts_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

Headers only: a streamed request body passes through untouched.

fn handle( &self, request: &Request, connection: &ConnectionInfo, next: &dyn Application, ) -> Result<Response, String>

fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool

true when this layer’s own work for request never blocks (in-memory state, atomics, short mutexes) — see Application::runs_inline. A WithMiddleware stack runs inline only if every layer and the inner application agree. Default false.

fn is_passthrough( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when handle would do nothing for request but call next (e.g. a rate limit that isn’t configured). A WithMiddleware stack offers the inner application’s execute_async only if every layer passes the request through. Default false.

fn answers_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer answers request itself — it doesn’t call next — and reads its body as a stream (a proxy forwarding it as it arrives). The body is then streamed whatever the layers after it and the application would say. Requires accepts_streamed_body. Since 18.3.0.

fn layer_name(&self) -> &'static str

A short name for this layer, as tools that describe an app list it (Application::middleware_names): by default the type’s name without its module path or generic parameters (CacheLayer). Since 18.28.0.