Skip to main content

EndpointGroup

Struct EndpointGroup 

Source
pub struct EndpointGroup { /* private fields */ }
Expand description

Endpoint group that applies a route prefix and shared safe defaults.

Implementations§

Source§

impl EndpointGroup

Source

pub fn new(prefix: RoutePath) -> Self

Creates a public endpoint group under one portable prefix.

Source

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

Sets the authorization inherited by new endpoints.

Source

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

Sets the rate limit inherited by new endpoints.

Source

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

Sets the timeout inherited by new endpoints.

Source

pub fn body_limit(self, policy: BodyLimitPolicy) -> Self

Sets the encoded body limit inherited by new endpoints.

Source

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

Sets the cross-origin policy inherited by new endpoints.

Source

pub const fn require_csrf(self) -> Self

Requires CSRF validation for new endpoints.

Source

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

Replaces security-header defaults inherited by new endpoints.

Source

pub fn without_security_headers(self) -> Self

Explicitly delegates security headers for new endpoints to the application.

Source

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

Sets the response-cache policy inherited by new endpoints.

Source

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

Replaces telemetry instructions inherited by new endpoints.

Source

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

Adds one documentation tag inherited by new endpoints.

Source

pub fn endpoint( &self, id: impl Into<String>, method: Method, path: RoutePath, ) -> SoapResult<EndpointMetadata>

Creates a new endpoint with the group prefix and policies applied.

Trait Implementations§

Source§

impl Clone for EndpointGroup

Source§

fn clone(&self) -> EndpointGroup

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EndpointGroup

Source§

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

Formats the value using the given formatter. Read more

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.