[−][src]Struct actix_web_grants::GrantsMiddleware
Built-in middleware for extracting user permission.
Examples
use actix_web::dev::ServiceRequest; use actix_web::{get, App, Error, HttpResponse, HttpServer, Responder}; use actix_web_grants::permissions::{AuthDetails, PermissionsCheck}; use actix_web_grants::{proc_macro::has_permissions, GrantsMiddleware}; fn main() { HttpServer::new(|| { let auth = GrantsMiddleware::with_extractor(extract); App::new() .wrap(auth) .service(you_service) }); } async fn extract(_req: &ServiceRequest) -> Result<Vec<String>, Error> { // Here is a place for your code to get user permissions/grants/permissions from a request // For example from a token or database // Stub example Ok(vec!["ROLE_ADMIN".to_string()]) } // `has_permissions` is one of options to validate permissions. #[get("/admin")] #[has_permissions("ROLE_ADMIN")] async fn you_service() -> impl Responder { HttpResponse::Ok().finish() }
Implementations
impl<T> GrantsMiddleware<T> where
T: PermissionsExtractor<'a>,
[src]
T: PermissionsExtractor<'a>,
pub fn with_extractor(extractor: T) -> GrantsMiddleware<T>
[src]
Create middleware by PermissionsExtractor
.
You can use a built-in implementation for async fn
with a suitable signature (see example below).
Or you can define your own implementation of trait.
Example of function with implementation of PermissionsExtractor
use actix_web::dev::ServiceRequest; use actix_web::Error; async fn extract(_req: &ServiceRequest) -> Result<Vec<String>, Error> { // Here is a place for your code to get user permissions/grants/permissions from a request // For example from a token or database Ok(vec!["WRITE_ACCESS".to_string()]) }
Trait Implementations
impl<S, B, T> Transform<S> for GrantsMiddleware<T> where
S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
T: PermissionsExtractor<'a> + 'static,
[src]
S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
T: PermissionsExtractor<'a> + 'static,
type Request = ServiceRequest
Requests handled by the service.
type Response = ServiceResponse<B>
Responses given by the service.
type Error = Error
Errors produced by the service.
type Transform = GrantsService<S, T>
The TransformService
value created by this factory
type InitError = ()
Errors produced while building a transform service.
type Future = Ready<Result<Self::Transform, Self::InitError>>
The future response value.
pub fn new_transform(&self, service: S) -> Self::Future
[src]
pub fn map_init_err<F, E>(self, f: F) -> TransformMapInitErr<Self, S, F, E> where
F: Fn(Self::InitError) -> E + Clone,
F: Fn(Self::InitError) -> E + Clone,
Auto Trait Implementations
impl<T> RefUnwindSafe for GrantsMiddleware<T> where
T: RefUnwindSafe,
[src]
T: RefUnwindSafe,
impl<T> Send for GrantsMiddleware<T> where
T: Send + Sync,
[src]
T: Send + Sync,
impl<T> Sync for GrantsMiddleware<T> where
T: Send + Sync,
[src]
T: Send + Sync,
impl<T> Unpin for GrantsMiddleware<T>
[src]
impl<T> UnwindSafe for GrantsMiddleware<T> where
T: RefUnwindSafe,
[src]
T: RefUnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,