Skip to main content

ControllerDefinition

Struct ControllerDefinition 

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

Group routes under a common HTTP prefix, similar to a Nest controller.

Implementations§

Source§

impl ControllerDefinition

Source

pub fn new(prefix: impl Into<String>) -> Result<Self>

Source

pub fn route(self, route: RouteDefinition) -> Result<Self>

Source

pub fn with_pipe<P>(self, pipe: P) -> Self
where P: Pipe,

Source

pub fn with_guard<G>(self, guard: G) -> Self
where G: Guard,

Source

pub fn with_interceptor<I>(self, interceptor: I) -> Self
where I: Interceptor,

Source

pub fn with_filter<F>(self, filter: F) -> Self
where F: ExceptionFilter,

Source

pub fn get<H>(self, path: impl Into<String>, handler: H) -> Result<Self>
where H: RouteHandler,

Source

pub fn get_json<H, Fut, R>( self, path: impl Into<String>, handler: H, ) -> Result<Self>
where H: Fn(BootRequest) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: Serialize + Send + 'static,

Source

pub fn get_json_with_status<H, Fut, R>( self, path: impl Into<String>, status: u16, handler: H, ) -> Result<Self>
where H: Fn(BootRequest) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: Serialize + Send + 'static,

Source

pub fn sse<H, Fut, S>(self, path: impl Into<String>, handler: H) -> Result<Self>
where H: Fn(BootRequest) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<S>> + Send + 'static, S: Stream<Item = Result<SseEvent>> + Send + 'static,

Source

pub fn post<H>(self, path: impl Into<String>, handler: H) -> Result<Self>
where H: RouteHandler,

Source

pub fn post_json<T, H, Fut, R>( self, path: impl Into<String>, handler: H, ) -> Result<Self>
where T: DeserializeOwned + Send + 'static, H: Fn(T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: Serialize + Send + 'static,

Source

pub fn post_json_with_status<T, H, Fut, R>( self, path: impl Into<String>, status: u16, handler: H, ) -> Result<Self>
where T: DeserializeOwned + Send + 'static, H: Fn(T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: Serialize + Send + 'static,

Source

pub fn put<H>(self, path: impl Into<String>, handler: H) -> Result<Self>
where H: RouteHandler,

Source

pub fn put_json<T, H, Fut, R>( self, path: impl Into<String>, handler: H, ) -> Result<Self>
where T: DeserializeOwned + Send + 'static, H: Fn(T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: Serialize + Send + 'static,

Source

pub fn put_json_with_status<T, H, Fut, R>( self, path: impl Into<String>, status: u16, handler: H, ) -> Result<Self>
where T: DeserializeOwned + Send + 'static, H: Fn(T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: Serialize + Send + 'static,

Source

pub fn patch_json<T, H, Fut, R>( self, path: impl Into<String>, handler: H, ) -> Result<Self>
where T: DeserializeOwned + Send + 'static, H: Fn(T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: Serialize + Send + 'static,

Source

pub fn patch_json_with_status<T, H, Fut, R>( self, path: impl Into<String>, status: u16, handler: H, ) -> Result<Self>
where T: DeserializeOwned + Send + 'static, H: Fn(T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: Serialize + Send + 'static,

Source

pub fn patch<H>(self, path: impl Into<String>, handler: H) -> Result<Self>
where H: RouteHandler,

Source

pub fn delete<H>(self, path: impl Into<String>, handler: H) -> Result<Self>
where H: RouteHandler,

Source

pub fn delete_json<H, Fut, R>( self, path: impl Into<String>, handler: H, ) -> Result<Self>
where H: Fn(BootRequest) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: Serialize + Send + 'static,

Source

pub fn delete_json_with_status<H, Fut, R>( self, path: impl Into<String>, status: u16, handler: H, ) -> Result<Self>
where H: Fn(BootRequest) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: Serialize + Send + 'static,

Source

pub fn options<H>(self, path: impl Into<String>, handler: H) -> Result<Self>
where H: RouteHandler,

Source

pub fn head<H>(self, path: impl Into<String>, handler: H) -> Result<Self>
where H: RouteHandler,

Source

pub fn prefix(&self) -> &str

Source

pub fn routes(&self) -> &[RouteDefinition]

Trait Implementations§

Source§

impl Clone for ControllerDefinition

Source§

fn clone(&self) -> ControllerDefinition

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

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> 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.
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