Struct ProjectionRoute 

pub struct ProjectionRoute {
    pub id: String,
    pub path: String,
    pub what: String,
    pub availability: Availability,
}

One route the projection answers for itself, as the OpenAPI document, the published site and the Cockpit all show it: where it answers, what it is, and whether a publication can carry it.

This is not a fourth list. Every entry is a surface discover::native_all resolved from the constants that already declare it, so a prefix that moves moves here, and the description is the producer’s own title rather than a sentence written beside it.

Fields

id: String

The surface’s identity in the topology.

path: String

Where it answers.

what: String

One line: what it is, in the words of the surface that declares it.

availability: Availability

Whether the running executable, a publication, or both answer for it.

Implementations

impl ProjectionRoute

pub fn linkable(&self) -> bool

May a published page offer this as a link a reader can follow?

A page that a publication carries can link it. A page that only a running process answers cannot: on a published site that link is a promise nothing keeps, and the usual repair — a test on the page’s own address — hides the rule in a template.

use majordomus_cli::web::projection_routes;
let swagger = projection_routes().into_iter().find(|r| r.id == "swagger").unwrap();
assert!(!swagger.linkable(), "no server, no console");

Trait Implementations

impl Clone for ProjectionRoute

fn clone(&self) -> ProjectionRoute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectionRoute

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

Formats the value using the given formatter.

impl Eq for ProjectionRoute

impl PartialEq for ProjectionRoute

fn eq(&self, other: &ProjectionRoute) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ProjectionRoute

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProjectionRoute