Struct RouteDefinition 

pub struct RouteDefinition { /* private fields */ }

A framework-neutral route definition.

Implementations

impl RouteDefinition

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

where H: RouteHandler,

pub fn get_json<H, Fut, R>(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,

pub fn get_json_with_status<H, Fut, R>( 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,

pub fn sse<H, Fut, S>(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,

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

where H: RouteHandler,

pub fn post_json<T, H, Fut, R>( 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,

pub fn post_json_with_status<T, H, Fut, R>( 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,

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

where H: RouteHandler,

pub fn put_json<T, H, Fut, R>( 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,

pub fn put_json_with_status<T, H, Fut, R>( 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,

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

where H: RouteHandler,

pub fn patch_json<T, H, Fut, R>( 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,

pub fn patch_json_with_status<T, H, Fut, R>( 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,

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

where H: RouteHandler,

pub fn delete_json<H, Fut, R>( 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,

pub fn delete_json_with_status<H, Fut, R>( 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,

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

where H: RouteHandler,

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

where H: RouteHandler,

impl RouteDefinition

pub fn new<H>( method: HttpMethod, path: impl Into<String>, handler: H, ) -> Result<Self>

where H: RouteHandler,

pub fn method(&self) -> HttpMethod

pub fn path(&self) -> &str

pub fn path_shape(&self) -> String

pub fn path_param_names(&self) -> Vec<&str>

pub fn matches_path(&self, path: &str) -> bool

pub fn path_params( &self, path: &str, ) -> Result<Option<BTreeMap<String, String>>>

pub fn module_name(&self) -> Option<&str>

pub fn controller_prefix(&self) -> Option<&str>

pub fn handler(&self) -> Arc<dyn RouteHandler>

impl RouteDefinition

pub async fn call(&self, request: BootRequest) -> Result<BootResponse>

pub async fn handle(&self, request: BootRequest) -> BootResponse

Dispatch a request through this route and convert unhandled errors into Boot HTTP responses.

impl RouteDefinition

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

where P: Pipe,

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

where G: Guard,

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

where I: Interceptor,

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

where F: ExceptionFilter,

Trait Implementations

impl Clone for RouteDefinition

fn clone(&self) -> RouteDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.