Struct actix_web_httpauth::extractors::bearer::BearerAuth
source · pub struct BearerAuth(/* private fields */);
Expand description
Extractor for HTTP Bearer auth
§Examples
use actix_web_httpauth::extractors::bearer::BearerAuth;
async fn index(auth: BearerAuth) -> String {
format!("Hello, user with token {}!", auth.token())
}
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::bearer::{self, BearerAuth};
async fn index(auth: BearerAuth) -> String {
format!("Hello, {}!", auth.token())
}
App::new()
.app_data(
bearer::Config::default()
.realm("Restricted area")
.scope("email photo"),
)
.service(web::resource("/index.html").route(web::get().to(index)));
Implementations§
Trait Implementations§
source§impl Clone for BearerAuth
impl Clone for BearerAuth
source§fn clone(&self) -> BearerAuth
fn clone(&self) -> BearerAuth
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for BearerAuth
impl Debug for BearerAuth
source§impl FromRequest for BearerAuth
impl FromRequest for BearerAuth
§type Future = Ready<Result<BearerAuth, <BearerAuth as FromRequest>::Error>>
type Future = Ready<Result<BearerAuth, <BearerAuth as FromRequest>::Error>>
Future that resolves to a
Self
. Read more§type Error = AuthenticationError<Bearer>
type Error = AuthenticationError<Bearer>
The associated error which can be returned.
source§fn from_request(
req: &HttpRequest,
_payload: &mut Payload,
) -> <Self as FromRequest>::Future
fn from_request( req: &HttpRequest, _payload: &mut Payload, ) -> <Self as FromRequest>::Future
Create a
Self
from request parts asynchronously.Auto Trait Implementations§
impl Freeze for BearerAuth
impl RefUnwindSafe for BearerAuth
impl Send for BearerAuth
impl Sync for BearerAuth
impl Unpin for BearerAuth
impl UnwindSafe for BearerAuth
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
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)