Struct ViewerRoute 

pub struct ViewerRoute {
    pub path: String,
    pub method: HttpMethod,
    pub type: String,
}

One HTTP route a plugin’s viewer registers on the host viewer’s embedded axum server. The full path served is /plugin/<repository>/<self.path>; on a hit, the body is JSON-decoded and forwarded as a PluginRequest { type: self.type, value: body } event to the frontend.

Fields

path: String

Path relative to the plugin’s namespace. Must start with /; the host prepends /plugin/<repository> before registering.

method: HttpMethod

HTTP method this route handles. Methods other than the listed five aren’t supported (and don’t appear in plugin practice).

type: String

String tag forwarded to the plugin’s iframe as the type field of the resulting PluginRequest. Plugin authors pick any value they want; the host doesn’t interpret it.

Trait Implementations

impl Clone for ViewerRoute

fn clone(&self) -> ViewerRoute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ViewerRoute

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ViewerRoute

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ViewerRoute

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 ViewerRoute

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

where __S: Serializer,

Serialize this value into the given Serde serializer.