Struct TunnelQuery 

pub struct TunnelQuery {
    pub port: u16,
    pub identity: bool,
}

?port=<n>[&identity=true] — the guest port to relay to, and whether to prove identity.

Fields

port: u16

The guest port. Dialled on 127.0.0.1 only.

0 parses and is refused after the upgrade with close::BAD_PORT, rather than rejected as a parse error: a caller who named it gets a reason naming the port instead of a 400 that could equally mean a missing parameter.

identity: bool

Whether to run a Noise KK handshake before relaying any bytes.

On this struct rather than in a second query type because one route has one query contract, and the schema is generated from exactly that: a separate type would need a second extractor and would not appear in docs/schema.json at all.

Absent means false, which is what keeps every layer-2 client working unchanged. True against a VM launched without a seed is refused with close::NO_IDENTITY rather than silently downgraded — a caller who asked to verify identity and got an unverified tunnel would believe a proof it never received. See super::identity for what the handshake proves and its honest limit.

Trait Implementations

impl Debug for TunnelQuery

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

Formats the value using the given formatter.

impl Default for TunnelQuery

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TunnelQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for TunnelQuery

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.

impl Serialize for TunnelQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.