Skip to main content

RouteSpec

Struct RouteSpec 

Source
pub struct RouteSpec {
Show 23 fields pub summary: &'static str, pub description: &'static str, pub operation_id: &'static str, pub tags: &'static [&'static str], pub security: &'static [&'static str], pub status_code: Option<u16>, pub deprecated: bool, pub params: &'static [ParamSpec], pub has_body: bool, pub body_schema: Option<fn() -> Value>, pub query_schema: Option<fn() -> Value>, pub response_schema: Option<fn() -> Value>, pub cache_ttl_secs: u64, pub cache_key: &'static str, pub api_version: &'static str, pub sunset: &'static str, pub idempotent_ttl_secs: u64, pub policies: &'static [&'static str], pub audit_action: &'static str, pub audit_resource: &'static str, pub timeout_ms: u64, pub transactional: bool, pub mask_fields: &'static [&'static str],
}

Fields§

§summary: &'static str§description: &'static str§operation_id: &'static str§tags: &'static [&'static str]§security: &'static [&'static str]§status_code: Option<u16>§deprecated: bool§params: &'static [ParamSpec]§has_body: bool§body_schema: Option<fn() -> Value>§query_schema: Option<fn() -> Value>§response_schema: Option<fn() -> Value>§cache_ttl_secs: u64

#[CacheTTL(N)] — seconds. 0/None disables the cache interceptor for this route regardless of #[UseInterceptors(CacheInterceptor)].

§cache_key: &'static str

#[CacheKey("template")] — empty string falls back to method + ' ' + path + '?' + query.

§api_version: &'static str

#[Version("v1")] on the controller — empty string = unversioned. The version is also baked into the mounted path (/v1/...).

§sunset: &'static str

#[Deprecated(sunset = "YYYY-MM-DD")] — when non-empty the boundary adds RFC 8594 Deprecation/Sunset response headers.

§idempotent_ttl_secs: u64

#[Idempotent(ttl = "…")] — TTL seconds; 0 = not idempotent. Surfaces the Idempotency-Key header + 409 + replay header in OpenAPI.

§policies: &'static [&'static str]

#[RequirePolicies("…")] — ABAC actions gating this route.

§audit_action: &'static str

#[AuditLog(action, resource)] — empty action = no audit.

§audit_resource: &'static str§timeout_ms: u64

#[Timeout("…")] — milliseconds; 0 = no route deadline.

§transactional: bool

#[Transactional] present on the handler.

§mask_fields: &'static [&'static str]

#[MaskFields("…")] — route-local PII rules (surfaced in OpenAPI).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more