Struct SandboxContextArgs 

pub struct SandboxContextArgs {
    pub method: Option<String>,
    pub path: Option<String>,
    pub host: Option<String>,
    pub scheme: Option<String>,
    pub headers: Option<HashMap<String, SandboxValue>>,
    pub query_params: Option<HashMap<String, SandboxValue>>,
    pub body: Option<Value>,
    pub body_base64: Option<String>,
    pub remote_addr: Option<String>,
    pub protocol: Option<String>,
    pub message: Option<HashMap<String, Value>>,
    pub response: Option<SandboxResponseArgs>,
}

Fields

method: Option<String>

HTTP method. Default GET.

path: Option<String>

Request path without the query string, e.g. /hello/frenk. Default /.

host: Option<String>

Host header value. Default sandbox.local.

scheme: Option<String>

http (default) or https.

headers: Option<HashMap<String, SandboxValue>>

Request headers as an object: {"authorization": "Bearer x", "accept": ["a", "b"]}.

query_params: Option<HashMap<String, SandboxValue>>

Query parameters as an object (not a query string): {"page": "2"}.

body: Option<Value>

Request body as text. A JSON body may be passed as a JSON string ("{\"a\":1}") or directly as an object — it is serialized for you. Add a content-type header yourself when a plugin needs it.

body_base64: Option<String>

Base64 body for binary payloads. Exclusive with body.

remote_addr: Option<String>

Client address ip:port. Default 127.0.0.1:0.

protocol: Option<String>

http1 (default) or http2.

message: Option<HashMap<String, Value>>

Pre-seeded context.message entries (e.g. what an earlier node would have set), keyed by name.

response: Option<SandboxResponseArgs>

Seed the response to exercise response-phase plugins (response-rewrite, loggers): {"status_code": 200, "headers": {...}, "body": "..."}.

Trait Implementations

impl Debug for SandboxContextArgs

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SandboxContextArgs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SandboxContextArgs

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.