PluginContext

Struct PluginContext 

Source
pub struct PluginContext {
Show 20 fields pub request_headers: Vec<(String, String)>, pub response_headers: Vec<(String, String)>, pub request_body: Vec<u8>, pub response_body: Vec<u8>, pub plugin_config: Vec<u8>, pub vm_config: Vec<u8>, pub action: u32, pub local_response: Option<LocalResponse>, pub logs: Vec<(u32, String)>, pub shared_data: Arc<Mutex<SharedData>>, pub pending_callouts: Vec<PendingCallout>, pub callout_token_counter: u32, pub callout_response_headers: Vec<(String, String)>, pub callout_response_body: Vec<u8>, pub metrics: HashMap<String, PluginMetric>, pub current_context_id: u32, pub effective_context_id: u32, pub done: bool, pub memory_used: usize, pub memory_cap: usize, /* private fields */
}
Expand description

The per-instance context the host imports read from and write to.

Stored as the wasmtime store’s T type. The host import functions receive a &mut PluginContext via Caller and use it to exchange data with the plugin.

Fields§

§request_headers: Vec<(String, String)>

Request headers (set by the host before proxy_on_request_headers).

§response_headers: Vec<(String, String)>

Response headers (set by the host before proxy_on_response_headers).

§request_body: Vec<u8>

Request body (set by the host before proxy_on_request_body).

§response_body: Vec<u8>

Response body (set by the host before proxy_on_response_body).

§plugin_config: Vec<u8>

Plugin configuration (passed to proxy_on_configure).

§vm_config: Vec<u8>

VM configuration (passed to proxy_on_vm_start).

§action: u32

The action the plugin returned from the last phase callback.

§local_response: Option<LocalResponse>

Whether the plugin has called proxy_send_http_response (a short-circuit response). When set, the host should stop processing and return the stored response.

§logs: Vec<(u32, String)>

Log lines emitted by the plugin via proxy_log.

§shared_data: Arc<Mutex<SharedData>>

The VM-scoped shared-data store handle (see SharedData).

§pending_callouts: Vec<PendingCallout>

Callouts registered by proxy_http_call and not yet answered (DW-167). One instance can queue several; the dispatch driver performs them in FIFO order, one round each.

§callout_token_counter: u32

Monotonic callout-token counter (tokens are handed out by the host and delivered back with proxy_on_http_call_response).

§callout_response_headers: Vec<(String, String)>

The last delivered callout response’s header map (:status plus ordinary headers, hop-by-hop stripped) — what MapType 6 reads return inside proxy_on_http_call_response.

§callout_response_body: Vec<u8>

The last delivered callout response’s body — what BufferType 4 reads return inside proxy_on_http_call_response.

§metrics: HashMap<String, PluginMetric>

Metrics registered by the plugin.

§current_context_id: u32

The current context ID (set by the host before calling exports).

§effective_context_id: u32

The effective context ID (set by proxy_set_effective_context).

§done: bool

Whether proxy_done was called.

§memory_used: usize

Memory limiter state (tracks current allocation against the cap).

§memory_cap: usize

Memory cap in bytes.

Trait Implementations§

Source§

impl ResourceLimiter for PluginContext

The memory cap for a plugin instance, enforced via wasmtime’s ResourceLimiter trait on the store’s user data (PluginContext).

Source§

fn memory_growing( &mut self, _current: usize, desired: usize, _maximum: Option<usize>, ) -> Result<bool>

Notifies the resource limiter that an instance’s linear memory has been requested to grow. Read more
Source§

fn table_growing( &mut self, _current: usize, desired: usize, _maximum: Option<usize>, ) -> Result<bool>

Notifies the resource limiter that an instance’s table has been requested to grow. Read more
§

fn memory_grow_failed(&mut self, error: Error) -> Result<(), Error>

Notifies the resource limiter that growing a linear memory, permitted by the memory_growing method, has failed. Read more
§

fn table_grow_failed(&mut self, error: Error) -> Result<(), Error>

Notifies the resource limiter that growing a linear memory, permitted by the table_growing method, has failed. Read more
§

fn instances(&self) -> usize

The maximum number of instances that can be created for a Store. Read more
§

fn tables(&self) -> usize

The maximum number of tables that can be created for a Store. Read more
§

fn memories(&self) -> usize

The maximum number of linear memories that can be created for a Store Read more

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
§

impl<T> AnyExt for T
where T: Any + ?Sized,

§

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

Attempts to downcast this to T behind reference
§

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

Attempts to downcast this to T behind mutable reference
§

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

Attempts to downcast this to T behind Rc pointer
§

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

Attempts to downcast this to T behind Arc pointer
§

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

Attempts to downcast this to T behind Box pointer
§

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization
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
§

impl<T, X> CoerceTo<T> for X
where T: CoerceFrom<X> + ?Sized,

§

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

§

fn coerce_box_to(self: Box<X>) -> Box<T>

§

fn coerce_ref_to(&self) -> &T

§

fn coerce_mut_to(&mut self) -> &mut T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,