# mod.rs - source
Source of the Rust file `actix-web-httpauth/src/extractors/mod.rs`.
Keywords: rust, rustlang, rust-lang

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103

    //! Type-safe authentication information extractors

    use std::{
        future::Future,
        pin::Pin,
        task::{Context, Poll},
    };

    use actix_web::dev::ServiceRequest;
    use actix_web::Error;
    use futures_core::ready;
    use pin_project_lite::pin_project;

    pub mod basic;
    pub mod bearer;
    mod config;
    mod errors;

    pub use self::config::AuthExtractorConfig;
    pub use self::errors::AuthenticationError;

    /// Trait implemented by types that can extract
    /// HTTP authentication scheme credentials from the request.
    ///
    /// It is very similar to actix' `FromRequest` trait,
    /// except it operates with a `ServiceRequest` struct instead,
    /// therefore it can be used in the middlewares.
    ///
    /// You will not need it unless you want to implement your own
    /// authentication scheme.
    pub trait AuthExtractor: Sized {
        /// The associated error which can be returned.
        type Error: Into<Error>;

        /// Future that resolves into extracted credentials type.
        type Future: Future<Output = Result<Self, Self::Error>>;

        /// Parse the authentication credentials from the actix' `ServiceRequest`.
        fn from_service_request(req: &ServiceRequest) -> Self::Future;
    }

    impl<T: AuthExtractor> AuthExtractor for Option<T> {
        type Error = T::Error;

        type Future = AuthExtractorOptFut<T::Future>;

        fn from_service_request(req: &ServiceRequest) -> Self::Future {
            let fut = T::from_service_request(req);
            AuthExtractorOptFut { fut }
        }
    }

    pin_project! {
        #[doc(hidden)]
        pub struct AuthExtractorOptFut<F> {
            #[pin]
            fut: F
        }
    }

    impl<F, T, E> Future for AuthExtractorOptFut<F>
    where
        F: Future<Output = Result<T, E>>,
    {
        type Output = Result<Option<T>, E>;

        fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
            let res = ready!(self.project().fut.poll(cx));
            Poll::Ready(Ok(res.ok()))
        }
    }

    impl<T: AuthExtractor> AuthExtractor for Result<T, T::Error> {
        type Error = T::Error;

        type Future = AuthExtractorResFut<T::Future>;

        fn from_service_request(req: &ServiceRequest) -> Self::Future {
            AuthExtractorResFut {
                fut: T::from_service_request(req),
            }
        }
    }

    pin_project! {
        #[doc(hidden)]
        pub struct AuthExtractorResFut<F> {
            #[pin]
            fut: F
        }
    }

    impl<F, T, E> Future for AuthExtractorResFut<F>
    where
        F: Future<Output = Result<T, E>>,
    {
        type Output = Result<F::Output, E>;

        fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
            let res = ready!(self.project().fut.poll(cx));
            Poll::Ready(Ok(res))
        }
    }