Struct EndpointMetadata 

pub struct EndpointMetadata {
    pub name: String,
    pub method: Method,
    pub path: RoutePath,
    pub authorization: AuthorizationPolicy,
    pub rate_limit: Option<RateLimitPolicy>,
    pub timeout: Option<Duration>,
    pub tags: Vec<String>,
}

Portable endpoint metadata consumed by framework adapters and documentation.

Fields

name: String

Stable endpoint name used by diagnostics and API documentation.

method: Method

HTTP method.

path: RoutePath

Portable route path.

authorization: AuthorizationPolicy

Authorization requirement.

rate_limit: Option<RateLimitPolicy>

Optional rate-limit policy.

timeout: Option<Duration>

Optional request timeout.

tags: Vec<String>

Documentation and grouping tags.

Implementations

impl EndpointMetadata

pub fn new( name: impl Into<String>, method: Method, path: RoutePath, ) -> SoapResult<Self>

Creates endpoint metadata with public access and no optional policies.

pub fn authorize(self, policy: AuthorizationPolicy) -> Self

Sets the authorization policy.

pub fn rate_limit(self, policy: RateLimitPolicy) -> Self

Sets the rate-limit policy.

pub fn timeout(self, timeout: Duration) -> SoapResult<Self>

Sets a non-zero request timeout.

pub fn tag(self, tag: impl Into<String>) -> SoapResult<Self>

Adds a non-empty documentation tag once.

Trait Implementations

impl Clone for EndpointMetadata

fn clone(&self) -> EndpointMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointMetadata

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

Formats the value using the given formatter.

impl Eq for EndpointMetadata

impl PartialEq for EndpointMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EndpointMetadata