Struct EndpointMetadata 

pub struct EndpointMetadata {

    pub id: EndpointId,
    pub method: Method,
    pub path: RoutePath,
    pub success_status: StatusCode,
    pub authorization: AuthorizationPolicy,
    pub rate_limit: Option<RateLimitPolicy>,
    pub timeout: Option<Duration>,
    pub body_limit: Option<BodyLimitPolicy>,
    pub cors: Option<CorsPolicy>,
    pub csrf: CsrfPolicy,
    pub security_headers: Option<SecurityHeadersPolicy>,
    pub response_cache: Option<ResponseCachePolicy>,
    pub contracts: EndpointContracts,
    pub documentation: OperationDocumentation,
    pub telemetry: TelemetryPolicy,
    pub tags: Vec<String>,
}

Portable endpoint definition consumed by framework, auth, docs, and telemetry adapters.

Fields

id: EndpointId

Stable endpoint identity used by diagnostics and API documentation.

method: Method

HTTP method.

path: RoutePath

Portable route path.

success_status: StatusCode

Successful response status used when a handler returns plain output.

authorization: AuthorizationPolicy

Authentication and authorization requirement.

rate_limit: Option<RateLimitPolicy>

Optional request rate limit.

timeout: Option<Duration>

Optional request timeout.

body_limit: Option<BodyLimitPolicy>

Optional maximum encoded request body size.

cors: Option<CorsPolicy>

Optional cross-origin policy.

csrf: CsrfPolicy

Cross-site request-forgery requirement.

security_headers: Option<SecurityHeadersPolicy>

Optional security response headers. Secure defaults are enabled initially.

response_cache: Option<ResponseCachePolicy>

Optional HTTP response caching policy.

contracts: EndpointContracts

Logical validation and response schema references.

documentation: OperationDocumentation

Provider-neutral operation documentation.

telemetry: TelemetryPolicy

Provider-neutral tracing and metrics instructions.

tags: Vec<String>

Documentation and grouping tags.

Implementations

impl EndpointMetadata

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

Creates a public endpoint with secure headers and telemetry enabled.

pub fn success_status(self, status: StatusCode) -> SoapResult<Self>

Sets a successful 2xx response status.

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

Sets and validates 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 body_limit(self, policy: BodyLimitPolicy) -> Self

Limits the encoded request body before extraction.

pub fn cors(self, policy: CorsPolicy) -> Self

Sets the cross-origin policy.

pub const fn require_csrf(self) -> Self

Requires a CSRF adapter to validate the request.

pub fn security_headers(self, policy: SecurityHeadersPolicy) -> Self

Replaces the security response-header policy.

pub fn without_security_headers(self) -> Self

Explicitly delegates every security response header to the application.

pub fn response_cache(self, policy: ResponseCachePolicy) -> SoapResult<Self>

Sets an HTTP response caching policy.

pub fn request_contract(self, contract: RequestContract) -> Self

Adds or replaces a request contract for one location.

pub fn response_contract(self, contract: ResponseContract) -> Self

Adds or replaces a response contract for one status.

pub fn documentation(self, documentation: OperationDocumentation) -> Self

Replaces operation documentation.

pub fn telemetry(self, telemetry: TelemetryPolicy) -> Self

Replaces endpoint telemetry instructions.

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

Adds a non-empty documentation tag once.

pub fn validate(&self) -> SoapResult<()>

Validates invariants after direct public-field construction or mutation.

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