# actix_web::Scope - Rust
API documentation for the Rust `Scope` struct in crate `actix_web`.
Keywords: rust, rustlang, rust-lang, Scope

# [−] [src] Struct actix_web::Scope

    pub struct Scope<S> { /* fields omitted */ }

Resources scope

Scope is a set of resources with common root path. Scopes collect multiple paths under a common path prefix. Scope path can contain variable path segments as resources. Scope prefix is always complete path segment, i.e `/app` would be converted to a `/app/` and it would not match `/app` path.

You can get variable path segments from `HttpRequest::match_info()`. `Path` extractor also is able to extract scope level variable segments.

    use actix_web::{http, App, HttpRequest, HttpResponse};

    fn main() {
        let app = App::new().scope("/{project_id}/", |scope| {
            scope
                .resource("/path1", |r| r.f(|_| HttpResponse::Ok()))
                .resource("/path2", |r| r.f(|_| HttpResponse::Ok()))
                .resource("/path3", |r| r.f(|_| HttpResponse::MethodNotAllowed()))
        });
    }

In the above example three routes get registered:

- /{project_id}/path1 - reponds to all http method
- /{project_id}/path2 - `GET` requests
- /{project_id}/path3 - `HEAD` requests

## Methods

###

`impl<S: 'static> Scope<S>`

[src]

####

`pub fn new(path: &str) -> Scope<S>`

[src]

Create a new scope

####

`pub fn filter<T: Predicate<S> + 'static>(self, p: T) -> Self`

[src]

Add match predicate to scope.

    use actix_web::{http, pred, App, HttpRequest, HttpResponse, Path};

    fn index(data: Path<(String, String)>) -> &'static str {
        "Welcome!"
    }

    fn main() {
        let app = App::new().scope("/app", |scope| {
            scope
                .filter(pred::Header("content-type", "text/plain"))
                .route("/test1", http::Method::GET, index)
                .route("/test2", http::Method::POST, |_: HttpRequest| {
                    HttpResponse::MethodNotAllowed()
                })
        });
    }

####

`pub fn with_state<F, T: 'static>(self, path: &str, state: T, f: F) -> Scope<S> where F: FnOnce(Scope<T>) -> Scope<T>,`

[src]

Create nested scope with new state.

    use actix_web::{App, HttpRequest};

    struct AppState;

    fn index(req: &HttpRequest<AppState>) -> &'static str {
        "Welcome!"
    }

    fn main() {
        let app = App::new().scope("/app", |scope| {
            scope.with_state("/state2", AppState, |scope| {
                scope.resource("/test1", |r| r.f(index))
            })
        });
    }

####

`pub fn nested<F>(self, path: &str, f: F) -> Scope<S> where F: FnOnce(Scope<S>) -> Scope<S>,`

[src]

Create nested scope.

    use actix_web::{App, HttpRequest};

    struct AppState;

    fn index(req: &HttpRequest<AppState>) -> &'static str {
        "Welcome!"
    }

    fn main() {
        let app = App::with_state(AppState).scope("/app", |scope| {
            scope.nested("/v1", |scope| scope.resource("/test1", |r| r.f(index)))
        });
    }

####

`pub fn route<T, F, R>(self, path: &str, method: Method, f: F) -> Scope<S> where F: WithFactory<T, S, R>, R: Responder + 'static, T: FromRequest<S> + 'static,`

[src]

Configure route for a specific path.

This is a simplified version of the `Scope::resource()` method. Handler functions need to accept one request extractor argument.

This method could be called multiple times, in that case multiple routes would be registered for same resource path.

    use actix_web::{http, App, HttpRequest, HttpResponse, Path};

    fn index(data: Path<(String, String)>) -> &'static str {
        "Welcome!"
    }

    fn main() {
        let app = App::new().scope("/app", |scope| {
            scope.route("/test1", http::Method::GET, index).route(
                "/test2",
                http::Method::POST,
                |_: HttpRequest| HttpResponse::MethodNotAllowed(),
            )
        });
    }

####

`pub fn resource<F, R>(self, path: &str, f: F) -> Scope<S> where F: FnOnce(&mut Resource<S>) -> R + 'static,`

[src]

Configure resource for a specific path.

This method is similar to an `App::resource()` method. Resources may have variable path segments. Resource path uses scope path as a path prefix.

    use actix_web::*;

    fn main() {
        let app = App::new().scope("/api", |scope| {
            scope.resource("/users/{userid}/{friend}", |r| {
                r.get().f(|_| HttpResponse::Ok());
                r.head().f(|_| HttpResponse::MethodNotAllowed());
                r.route()
                    .filter(pred::Any(pred::Get()).or(pred::Put()))
                    .filter(pred::Header("Content-Type", "text/plain"))
                    .f(|_| HttpResponse::Ok())
            })
        });
    }

####

`pub fn default_resource<F, R>(self, f: F) -> Scope<S> where F: FnOnce(&mut Resource<S>) -> R + 'static,`

[src]

Default resource to be used if no matching route could be found.

####

`pub fn handler<H: Handler<S>>(self, path: &str, handler: H) -> Scope<S>`

[src]

Configure handler for specific path prefix.

A path prefix consists of valid path segments, i.e for the prefix `/app` any request with the paths `/app`, `/app/` or `/app/test` would match, but the path `/application` would not.

    use actix_web::{http, App, HttpRequest, HttpResponse};

    fn main() {
        let app = App::new().scope("/scope-prefix", |scope| {
            scope.handler("/app", |req: &HttpRequest| match *req.method() {
                http::Method::GET => HttpResponse::Ok(),
                http::Method::POST => HttpResponse::MethodNotAllowed(),
                _ => HttpResponse::NotFound(),
            })
        });
    }

####

`pub fn middleware<M: Middleware<S>>(self, mw: M) -> Scope<S>`

[src]

Register a scope middleware

This is similar to `App's` middlewares, but middlewares get invoked on scope level.

Note `Middleware::finish()` fires right after response get prepared. It does not wait until body get sent to the peer.

## Auto Trait Implementations

###

`impl<S> !Send for Scope<S>`

###

`impl<S> !Sync for Scope<S>`

## Blanket Implementations

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

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

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from`)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from`)

Performs the conversion.

###

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

[src]

####

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

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

[src]

####

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

[src]

Mutably borrows from an owned value. Read more

###

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

[src]

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

🔬 This is a nightly-only experimental API. (`try_from`)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from`)

Performs the conversion.

###

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

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id`)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

`impl<T> Erased for T`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)