Struct Scope

pub struct Scope<S = Scope> { /* private fields */ }

Wrapper for actix_web::Scope

Implementations

impl Scope

pub fn new(path: &str) -> Self

Wrapper for actix_web::Scope::new

impl<T> Scope<Scope<T>>

where T: ServiceFactory<ServiceRequest, Config = (), Error = Error, InitError = ()>,

pub fn guard<G: Guard + 'static>(self, guard: G) -> Self

Proxy for actix_web::Scope::guard.

NOTE: This doesn’t affect spec generation.

pub fn app_data<U: 'static>(self, data: U) -> Self

Proxy for actix_web::Scope::app_data.

NOTE: This doesn’t affect spec generation.

pub fn configure<F>(self, f: F) -> Self

where F: FnOnce(&mut ServiceConfig<'_>),

Wrapper for actix_web::Scope::configure.

pub fn service<F>(self, factory: F) -> Self

where F: Mountable + HttpServiceFactory + 'static,

Wrapper for actix_web::Scope::service.

pub fn route(self, path: &str, route: Route) -> Self

Wrapper for actix_web::Scope::route.

pub fn default_service<F, U>(self, f: F) -> Self

where F: IntoServiceFactory<U, ServiceRequest>, U: ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse, Error = Error, InitError = ()> + 'static, U::InitError: Debug,

Proxy for actix_web::web::Scope::default_service.

NOTE: This doesn’t affect spec generation.

pub fn wrap<M, B>( self, mw: M, ) -> Scope<Scope<impl ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse<B>, Error = Error, InitError = ()>>>

where M: Transform<T::Service, ServiceRequest, Response = ServiceResponse<B>, Error = Error, InitError = ()> + 'static, B: MessageBody,

Proxy for actix_web::web::Scope::wrap.

NOTE: This doesn’t affect spec generation.

pub fn wrap_fn<F, R>( self, mw: F, ) -> Scope<Scope<impl ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse, Error = Error, InitError = ()>>>

where F: Fn(ServiceRequest, &T::Service) -> R + Clone + 'static, R: Future<Output = Result<ServiceResponse, Error>>,

Proxy for actix_web::web::Scope::wrap_fn.

NOTE: This doesn’t affect spec generation.

Trait Implementations

impl<T, B> HttpServiceFactory for Scope<Scope<T>>

where T: ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse<B>, Error = Error, InitError = ()> + 'static, B: MessageBody + 'static,

fn register(self, config: &mut AppService)

impl<T> Mountable for Scope<T>

fn path(&self) -> &str

Where this thing gets mounted.

fn operations(&mut self) -> BTreeMap<HttpMethod, DefaultOperationRaw>

Map of HTTP methods and the associated API operations.

fn security_definitions(&mut self) -> BTreeMap<String, SecurityScheme>

The security definitions recorded by this object.

fn definitions(&mut self) -> BTreeMap<String, DefaultSchemaRaw>

The definitions recorded by this object.

fn update_operations(&mut self, map: &mut BTreeMap<String, DefaultPathItemRaw>)

Updates the given map of operations with operations tracked by this object.