Struct gotham::router::builder::ScopeBuilder

pub struct ScopeBuilder<'a, C, P> where
    C: PipelineHandleChain<P> + Copy + Send + Sync + 'static,
    P: Send + Sync + 'static,  { /* private fields */ }

A scoped builder, which is created by DrawRoutes::scope and passed to the provided closure. The DrawRoutes trait has documentation for using this type.

Trait Implementations

impl<'a, C, P> DrawRoutes<C, P> for ScopeBuilder<'a, C, P> where
    C: PipelineHandleChain<P> + Copy + Send + Sync + 'static,
    P: RefUnwindSafe + Send + Sync + 'static, 

fn get_or_head<'b>(
    &'b mut self,
    path: &str
) -> SingleRouteBuilder<'b, MethodOnlyRouteMatcher, C, P, NoopPathExtractor, NoopQueryStringExtractor>

Creates a route which matches GET and HEAD requests to the given path.

fn get<'b>(
    &'b mut self,
    path: &str
) -> SingleRouteBuilder<'b, MethodOnlyRouteMatcher, C, P, NoopPathExtractor, NoopQueryStringExtractor>

Creates a route which matches only GET requests to the given path (ignoring HEAD requests).

fn head<'b>(
    &'b mut self,
    path: &str
) -> SingleRouteBuilder<'b, MethodOnlyRouteMatcher, C, P, NoopPathExtractor, NoopQueryStringExtractor>

Creates a route which matches HEAD requests to the given path.

fn post<'b>(
    &'b mut self,
    path: &str
) -> SingleRouteBuilder<'b, MethodOnlyRouteMatcher, C, P, NoopPathExtractor, NoopQueryStringExtractor>

Creates a route which matches POST requests to the given path.

fn put<'b>(
    &'b mut self,
    path: &str
) -> SingleRouteBuilder<'b, MethodOnlyRouteMatcher, C, P, NoopPathExtractor, NoopQueryStringExtractor>

Creates a route which matches PUT requests to the given path.

fn patch<'b>(
    &'b mut self,
    path: &str
) -> SingleRouteBuilder<'b, MethodOnlyRouteMatcher, C, P, NoopPathExtractor, NoopQueryStringExtractor>

Creates a route which matches PATCH requests to the given path.

fn delete<'b>(
    &'b mut self,
    path: &str
) -> SingleRouteBuilder<'b, MethodOnlyRouteMatcher, C, P, NoopPathExtractor, NoopQueryStringExtractor>

Creates a route which matches DELETE requests to the given path.

fn options<'b>(
    &'b mut self,
    path: &str
) -> SingleRouteBuilder<'b, MethodOnlyRouteMatcher, C, P, NoopPathExtractor, NoopQueryStringExtractor>

Creates a route which matches OPTIONS requests to the given path.

fn request<'b, IRM, M>(
    &'b mut self,
    matcher: IRM,
    path: &str
) -> SingleRouteBuilder<'b, M, C, P, NoopPathExtractor, NoopQueryStringExtractor> where
    IRM: IntoRouteMatcher<Output = M>,
    M: RouteMatcher + Send + Sync + 'static, 

Creates a single route which matches any requests to the given path with one of the given methods. The path can consist of static or dynamic segments, for example:

fn scope<F>(&mut self, path: &str, f: F) where
    F: FnOnce(&mut ScopeBuilder<'_, C, P>), 

Begins defining a new scope, based on a given path prefix.

fn with_pipeline_chain<F, NC>(&mut self, pipeline_chain: NC, f: F) where
    F: FnOnce(&mut ScopeBuilder<'_, NC, P>),
    NC: PipelineHandleChain<P> + Copy + Send + Sync + 'static, 

Begins a new scope at the current location, with an alternate pipeline chain.

fn delegate<'b>(
    &'b mut self,
    path: &str
) -> DelegateRouteBuilder<'b, AnyRouteMatcher, C, P>

Begins delegating a subpath of the tree.

fn delegate_without_pipelines<'b>(
    &'b mut self,
    path: &str
) -> DelegateRouteBuilder<'b, AnyRouteMatcher, (), P>

Begins delegating a subpath of the tree, but does not dispatch the requests via this router’s PipelineChain.

fn associate<'b, F>(&'b mut self, path: &str, f: F) where
    F: FnOnce(&mut AssociatedRouteBuilder<'b, AnyRouteMatcher, C, P, NoopPathExtractor, NoopQueryStringExtractor>), 

Begins associating routes with a fixed path in the tree. In this way, multiple routes can be quickly associated with a single location.