Struct actix_web_httpauth::extractors::basic::BasicAuth
source · pub struct BasicAuth(/* private fields */);
Expand description
Extractor for HTTP Basic auth.
Examples
use actix_web_httpauth::extractors::basic::BasicAuth;
async fn index(auth: BasicAuth) -> String {
format!("Hello, {}!", auth.user_id())
}
If authentication fails, this extractor fetches the Config
instance from the app data in
order to properly form the WWW-Authenticate
response header.
Examples
use actix_web::{web, App};
use actix_web_httpauth::extractors::basic::{self, BasicAuth};
async fn index(auth: BasicAuth) -> String {
format!("Hello, {}!", auth.user_id())
}
App::new()
.app_data(basic::Config::default().realm("Restricted area"))
.service(web::resource("/index.html").route(web::get().to(index)));
Implementations§
Trait Implementations§
source§impl FromRequest for BasicAuth
impl FromRequest for BasicAuth
§type Future = Ready<Result<BasicAuth, <BasicAuth as FromRequest>::Error>>
type Future = Ready<Result<BasicAuth, <BasicAuth as FromRequest>::Error>>
Future that resolves to a
Self
. Read more§type Error = AuthenticationError<Basic>
type Error = AuthenticationError<Basic>
The associated error which can be returned.
source§fn from_request(
req: &HttpRequest,
_: &mut Payload
) -> <Self as FromRequest>::Future
fn from_request( req: &HttpRequest, _: &mut Payload ) -> <Self as FromRequest>::Future
Create a
Self
from request parts asynchronously.Auto Trait Implementations§
impl RefUnwindSafe for BasicAuth
impl Send for BasicAuth
impl Sync for BasicAuth
impl Unpin for BasicAuth
impl UnwindSafe for BasicAuth
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more