Struct HttpExposure 

pub struct HttpExposure {
    pub method: HttpMethod,
    pub path: String,
}

How a capability appears over HTTP. GET binds every top-level input property as a query parameter; POST binds the input as the JSON request body. Paths are absolute and live under HttpExposure::PREFIX.

Fields

method: HttpMethod

The method.

path: String

The absolute path, under HttpExposure::PREFIX.

Implementations

impl HttpExposure

pub const PREFIX: &'static str = "/api/v1/"

Every capability route starts here; the version is part of the contract.

pub fn validate(&self) -> Result<(), String>

Is the path one this projection can serve? The reason when it is not.

use majordomus_cli::capability::{HttpExposure, HttpMethod};
let ok = HttpExposure { method: HttpMethod::Get, path: "/api/v1/objects".into() };
assert!(ok.validate().is_ok());
let bad = HttpExposure { method: HttpMethod::Get, path: "/objects".into() };
assert!(bad.validate().unwrap_err().contains("/api/v1/"));

Trait Implementations

impl Clone for HttpExposure

fn clone(&self) -> HttpExposure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpExposure

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HttpExposure

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for HttpExposure

impl JsonSchema for HttpExposure

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 PartialEq for HttpExposure

fn eq(&self, other: &HttpExposure) -> 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 HttpExposure

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 HttpExposure