Trait EndpointMetadata

pub trait EndpointMetadata {
    // Required methods
    fn method(&self) -> Method;
    fn path(&self) -> &[PathSegment];
    fn template(&self) -> &str;
    fn service_name(&self) -> &str;
    fn name(&self) -> &str;
    fn deprecated(&self) -> Option<&str>;
}

Metadata about an HTTP endpoint.

Required Methods

fn method(&self) -> Method

The endpoint’s HTTP method.

fn path(&self) -> &[PathSegment]

The endpoint’s parsed HTTP URI path.

Each value in the slice represents one segment of the URI.

fn template(&self) -> &str

The endpoint’s raw HTTP URI template.

Use the Self::path() method for routing rather than parsing this string.

fn service_name(&self) -> &str

The name of the service defining this endpoint.

fn name(&self) -> &str

The name of the endpoint.

fn deprecated(&self) -> Option<&str>

If the endpoint is deprecated, returns the deprecation documentation.

Implementations on Foreign Types

impl<T> EndpointMetadata for Box<T>

where T: ?Sized + EndpointMetadata,

fn method(&self) -> Method

fn path(&self) -> &[PathSegment]

fn template(&self) -> &str

fn service_name(&self) -> &str

fn name(&self) -> &str

fn deprecated(&self) -> Option<&str>

Implementors

impl<I, O> EndpointMetadata for BoxAsyncEndpoint<'_, I, O>