Struct SetVarsPlugin 

pub struct SetVarsPlugin {
    vars: Vec<VarRule>,
}

Evaluates every rule in order and writes each result into context.message[name] as a string. Later rules see earlier results ($msg_<name>), so rules can build on each other.

Fields

vars: Vec<VarRule>

Implementations

impl SetVarsPlugin

pub fn from_config(config: &HashMap<String, Value>) -> Result<Self, String>

Builds the plugin from node config; every regex and JSONPath is compiled here so mistakes fail policy compilation, not requests.

Accepted keys:

• vars (array, required, non-empty), each entry:
  • name (string, required): message key; readable downstream as $msg_<name> / {{message.<name>}}. Letters, digits, _, -, ..
  • from (string): source template — $uri, $http_<h>, $arg_<q>, $cookie_<c>, $msg_<k>, or {{request.path}}-style references. Required unless json_path is set (then defaults to the request body).
  • json_path (string): RFC 9535 JSONPath applied to from parsed as JSON. One scalar node → its text; one object/array → its JSON text; several nodes → a JSON array text; none → default.
  • regex (string): applied after json_path; group (integer or capture name, default 1; 0 = whole match) selects the value.
  • default (string): fallback when nothing matches.

type: set-vars
config:
  vars:
    - { name: user, from: $uri, regex: '^/hello/([^/]+)', default: stranger }
    - { name: tenant, from: $http_x_tenant }
    - { name: order_id, json_path: $.order.id }

Trait Implementations

impl Debug for SetVarsPlugin

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

Formats the value using the given formatter.

impl Plugin for SetVarsPlugin

fn plugin_type(&self) -> &str

Unique identifier for the plugin type (e.g., “proxy-rewrite”, “upstream”). This is also the key its PortSpec is registered under in port_spec.

fn execute<'life0, 'async_trait>( &'life0 self, ctx: Context, ) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executes the plugin logic against the request/response context.

fn reads_response_body(&self) -> bool

Whether this configured instance reads context.response.body.

fn cache_target(&self) -> Option<CacheTarget>

The cache backend this node writes to, if it is a proxy-cache half.