Struct gotham_restful::AuthMiddleware

pub struct AuthMiddleware<Data, Handler> { /* private fields */ }

This is the auth middleware. To use it, first make sure you have the auth feature enabled. Then simply add it to your pipeline and request it inside your handler:

#[derive(Resource)]
#[resource(read_all)]
struct AuthResource;

#[derive(Debug, Deserialize, Clone)]
struct AuthData {
	sub: String,
	exp: u64
}

#[read_all]
fn read_all(auth: &AuthStatus<AuthData>) -> Success<String> {
	format!("{auth:?}").into()
}

fn main() {
	let auth: AuthMiddleware<AuthData, _> = AuthMiddleware::new(
		AuthSource::AuthorizationHeader,
		AuthValidation::default(),
		StaticAuthHandler::from_array(b"zlBsA2QXnkmpe0QTh8uCvtAEa4j33YAc")
	);
	let (chain, pipelines) = single_pipeline(new_pipeline().add(auth).build());
	gotham::start(
		"127.0.0.1:8080",
		build_router(chain, pipelines, |route| {
			route.resource::<AuthResource>("auth");
		})
	);
}

Implementations

impl<Data, Handler> AuthMiddleware<Data, Handler>where
    Data: DeserializeOwned + Send,
    Handler: AuthHandler<Data> + Default,

pub fn from_source(source: AuthSource) -> Self

impl<Data, Handler> AuthMiddleware<Data, Handler>where
    Data: DeserializeOwned + Send,
    Handler: AuthHandler<Data>,

pub fn new(
    source: AuthSource,
    validation: AuthValidation,
    handler: Handler
) -> Self

Trait Implementations

impl<Data, Handler> Clone for AuthMiddleware<Data, Handler>where
    Handler: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Data: Debug, Handler: Debug> Debug for AuthMiddleware<Data, Handler>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Data, Handler> Middleware for AuthMiddleware<Data, Handler>where
    Data: DeserializeOwned + Send + 'static,
    Handler: AuthHandler<Data>,

fn call<Chain>(self, state: State, chain: Chain) -> Pin<Box<HandlerFuture>>where
    Chain: FnOnce(State) -> Pin<Box<HandlerFuture>>,

Entry point to the middleware. To pass the request on to the application, the middleware invokes the chain function with the provided state.

impl<Data, Handler> NewMiddleware for AuthMiddleware<Data, Handler>where
    Self: Clone + Middleware + Sync + RefUnwindSafe,

type Instance = AuthMiddleware<Data, Handler>

The type of Middleware created by the NewMiddleware.

fn new_middleware(&self) -> Result<Self>

Create and return a new Middleware value.