Struct paperclip_actix::web::Scope

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

Wrapper for actix_web::Scope

Methods

impl Scope

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

Wrapper for actix_web::Scope::new

impl<T> Scope<Scope<T>> where
    T: NewService<Config = (), Request = ServiceRequest, Response = ServiceResponse, 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 data<U: 'static>(self, data: U) -> Self

Proxy for actix_web::Scope::data.

NOTE: This doesn't affect spec generation.

pub fn configure<F>(self, f: F) -> Self where
    F: FnOnce(&mut ServiceConfig<Scope<T>>), 

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: IntoNewService<U>,
    U: NewService<Config = (), Request = ServiceRequest, 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, F>(
    self,
    mw: F
) -> Scope<Scope<impl NewService<Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = ()>>> where
    M: Transform<T::Service, Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = ()>,
    F: IntoTransform<M, T::Service>, 

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 NewService<Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = ()>>> where
    F: FnMut(ServiceRequest, &mut T::Service) -> R + Clone,
    R: IntoFuture<Item = ServiceResponse, Error = Error>, 

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

NOTE: This doesn't affect spec generation.

Trait Implementations

impl<T> Mountable for Scope<T>

fn path(&self) -> &str

Where this thing gets mounted.

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

Map of HTTP methods and the associated API operations.

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

The definitions recorded by this object.

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

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

impl<T> HttpServiceFactory for Scope<Scope<T>> where
    T: NewService<Config = (), Request = ServiceRequest, Response = ServiceResponse, Error = Error, InitError = ()> + 'static, 

fn register(self, config: &mut AppService)