diff --git a/actix_cors/all.html b/actix_cors/all.html index 52cbd1124..30cb27b52 100644 --- a/actix_cors/all.html +++ b/actix_cors/all.html @@ -1 +1 @@ -List of all items in this crate

List of all items

Structs

Enums

\ No newline at end of file +List of all items in this crate

List of all items

Structs

Enums

\ No newline at end of file diff --git a/actix_cors/enum.CorsError.html b/actix_cors/enum.CorsError.html index 35a6c35ca..c3eb1810f 100644 --- a/actix_cors/enum.CorsError.html +++ b/actix_cors/enum.CorsError.html @@ -1,4 +1,4 @@ -CorsError in actix_cors - Rust

Enum actix_cors::CorsError

source · 
#[non_exhaustive]
pub enum CorsError {
+CorsError in actix_cors - Rust
Enum actix_cors::CorsError
source · 
#[non_exhaustive]
pub enum CorsError {
     WildcardOrigin,
     MissingOrigin,
     MissingRequestMethod,
diff --git a/actix_cors/index.html b/actix_cors/index.html
index 0deef40b5..42511b1d1 100644
--- a/actix_cors/index.html
+++ b/actix_cors/index.html
@@ -1,4 +1,4 @@
-actix_cors - Rust

\ No newline at end of file
diff --git a/actix_settings/struct.BasicSettings.html b/actix_settings/struct.BasicSettings.html
index 8699dad13..02c520713 100644
--- a/actix_settings/struct.BasicSettings.html
+++ b/actix_settings/struct.BasicSettings.html
@@ -1,11 +1,11 @@
-BasicSettings in actix_settings - Rust
Struct actix_settings::BasicSettings
source · 
pub struct BasicSettings<A> {
+BasicSettings in actix_settings - Rust
Struct actix_settings::BasicSettings
source · 
pub struct BasicSettings<A> {
     pub actix: ActixSettings,
     pub application: A,
 }
Expand description
Wrapper for server and application-specific settings.

 
Fields§
§actix: ActixSettings
Actix Web server settings.

 
§application: A
Application-specific settings.

 
Implementations§
source§
impl<A> BasicSettings<A>where
-    A: DeserializeOwned,
source
pub fn parse_toml<P>(filepath: P) -> Result<Self, Error>where
+    A: DeserializeOwned,
source
pub fn parse_toml<P>(filepath: P) -> Result<Self, Error>where
     P: AsRef<Path>,
Parse an instance of Self from a TOML file located at filepath.

 
If the file doesn’t exist, it is generated from the default TOML template, after which the
 newly generated file is read in and parsed.

@@ -43,9 +43,9 @@ std::env::set_var("OVERRIDE__MODE", &mut settings.actix.mode, "OVERRIDE__MODE")?;
 assert_eq!(settings.actix.mode, Mode::Production);

-

Trait Implementations§

source§

impl<A: Clone> Clone for BasicSettings<A>

source§

fn clone(&self) -> BasicSettings<A>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<A: Debug> Debug for BasicSettings<A>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de, A> Deserialize<'de> for BasicSettings<A>where - A: Deserialize<'de>,

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where - __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<A: Hash> Hash for BasicSettings<A>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where +

Trait Implementations§

source§

impl<A: Clone> Clone for BasicSettings<A>

source§

fn clone(&self) -> BasicSettings<A>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<A: Debug> Debug for BasicSettings<A>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de, A> Deserialize<'de> for BasicSettings<A>where + A: Deserialize<'de>,

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where + __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<A: Hash> Hash for BasicSettings<A>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<A: PartialEq> PartialEq<BasicSettings<A>> for BasicSettings<A>

source§

fn eq(&self, other: &BasicSettings<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always @@ -75,5 +75,5 @@ sufficient, and should not be overridden without very good reason.
§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a -[WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for Twhere - T: for<'de> Deserialize<'de>,

\ No newline at end of file +[WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for Twhere + T: for<'de> Deserialize<'de>,

\ No newline at end of file diff --git a/actix_settings/struct.NoSettings.html b/actix_settings/struct.NoSettings.html index c85dde6bc..4a3f4f857 100644 --- a/actix_settings/struct.NoSettings.html +++ b/actix_settings/struct.NoSettings.html @@ -1,6 +1,6 @@ -NoSettings in actix_settings - Rust

Struct actix_settings::NoSettings

source · 
#[non_exhaustive]
pub struct NoSettings {}
Expand description

Marker type representing no defined application-specific settings.

-

Trait Implementations§

source§

impl Clone for NoSettings

source§

fn clone(&self) -> NoSettings

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for NoSettings

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for NoSettings

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where - __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Hash for NoSettings

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where +NoSettings in actix_settings - Rust

Struct actix_settings::NoSettings

source · 
#[non_exhaustive]
pub struct NoSettings {}
Expand description

Marker type representing no defined application-specific settings.

+

Trait Implementations§

source§

impl Clone for NoSettings

source§

fn clone(&self) -> NoSettings

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for NoSettings

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for NoSettings

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where + __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Hash for NoSettings

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq<NoSettings> for NoSettings

source§

fn eq(&self, other: &NoSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always @@ -25,5 +25,5 @@ sufficient, and should not be overridden without very good reason.

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a -[WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for Twhere - T: for<'de> Deserialize<'de>,

\ No newline at end of file +[WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for Twhere + T: for<'de> Deserialize<'de>,

\ No newline at end of file diff --git a/actix_settings/struct.Tls.html b/actix_settings/struct.Tls.html index 4c3ee9d5d..3cfcc10d4 100644 --- a/actix_settings/struct.Tls.html +++ b/actix_settings/struct.Tls.html @@ -1,4 +1,4 @@ -Tls in actix_settings - Rust

Struct actix_settings::Tls

source · 
pub struct Tls {
+Tls in actix_settings - Rust
Struct actix_settings::Tls
source · 
pub struct Tls {
     pub enabled: bool,
     pub certificate: PathBuf,
     pub private_key: PathBuf,
@@ -6,8 +6,8 @@
 
Fields§
§enabled: bool
Tru if accepting TLS connections should be enabled.

 
§certificate: PathBuf
Path to certificate .pem file.

 
§private_key: PathBuf
Path to private key .pem file.

-
Trait Implementations§
source§
impl Clone for Tls
source§
fn clone(&self) -> Tls
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for Tls
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl<'de> Deserialize<'de> for Tls
source§
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
-    __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§
impl Hash for Tls
source§
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given Hasher. Read more
1.3.0 · source§
fn hash_slice<H>(data: &[Self], state: &mut H)where
+
Trait Implementations§
source§
impl Clone for Tls
source§
fn clone(&self) -> Tls
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for Tls
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl<'de> Deserialize<'de> for Tls
source§
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
+    __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§
impl Hash for Tls
source§
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given Hasher. Read more
1.3.0 · source§
fn hash_slice<H>(data: &[Self], state: &mut H)where
     H: Hasher,
     Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§
impl PartialEq<Tls> for Tls
source§
fn eq(&self, other: &Tls) -> bool
This method tests for self and other values to be equal, and is used
 by ==.
1.0.0 · source§
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always
@@ -32,5 +32,5 @@ sufficient, and should not be overridden without very good reason.
§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a -[WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for Twhere - T: for<'de> Deserialize<'de>,

\ No newline at end of file +[WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for Twhere + T: for<'de> Deserialize<'de>,

\ No newline at end of file diff --git a/actix_settings/trait.ApplySettings.html b/actix_settings/trait.ApplySettings.html index 234230df8..51f506618 100644 --- a/actix_settings/trait.ApplySettings.html +++ b/actix_settings/trait.ApplySettings.html @@ -1,10 +1,10 @@ -ApplySettings in actix_settings - Rust

Trait actix_settings::ApplySettings

source · 
pub trait ApplySettings {
+ApplySettings in actix_settings - Rust
Trait actix_settings::ApplySettings
source · 
pub trait ApplySettings {
     // Required method
     fn apply_settings<A>(self, settings: &BasicSettings<A>) -> Self
-       where A: DeserializeOwned;
+       where A: DeserializeOwned;
 }
Expand description
Extension trait for applying parsed settings to the server object.

 
Required Methods§
source
fn apply_settings<A>(self, settings: &BasicSettings<A>) -> Selfwhere
-    A: DeserializeOwned,
Apply a BasicSettings value to self.

+    A: DeserializeOwned,
Apply a BasicSettings value to self.

 
Implementations on Foreign Types§
source§
impl<F, I, S, B> ApplySettings for HttpServer<F, I, S, B>where
     F: Fn() -> I + Send + Clone + 'static,
     I: IntoServiceFactory<S, Request>,
@@ -14,4 +14,4 @@
     S::Response: Into<Response<B>> + 'static,
     S::Future: 'static,
     B: MessageBody + 'static,
source§
fn apply_settings<A>(self, settings: &BasicSettings<A>) -> Selfwhere
-    A: DeserializeOwned,
Implementors§
\ No newline at end of file + A: DeserializeOwned,

Implementors§

\ No newline at end of file diff --git a/actix_settings/trait.Parse.html b/actix_settings/trait.Parse.html index ea837eebb..72d3e0270 100644 --- a/actix_settings/trait.Parse.html +++ b/actix_settings/trait.Parse.html @@ -1,6 +1,6 @@ -Parse in actix_settings - Rust

Trait actix_settings::Parse

source · 
pub trait Parse: Sized {
+Parse in actix_settings - Rust
Trait actix_settings::Parse
source · 
pub trait Parse: Sized {
     // Required method
     fn parse(string: &str) -> Result<Self, Error>;
 }
Expand description
A specialized FromStr trait that returns Error errors

 
Required Methods§
source
fn parse(string: &str) -> Result<Self, Error>
Parse Self from string.

-
Implementations on Foreign Types§
source§
impl Parse for PathBuf
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for u32
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for u128
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for i16
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for u8
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for u64
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for i64
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for String
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for Vec<Address>
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for i32
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for u16
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for bool
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for i8
source§
fn parse(string: &str) -> Result<Self, Error>
source§
impl Parse for i128
source§
fn parse(string: &str) -> Result<Self, Error>
Implementors§

\ No newline at end of file
+

Implementations on Foreign Types§

source§

impl Parse for u64

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for u128

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for i16

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for u16

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for i64

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for i128

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for u32

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for Vec<Address>

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for bool

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for i8

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for String

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for u8

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for PathBuf

source§

fn parse(string: &str) -> Result<Self, Error>

source§

impl Parse for i32

source§

fn parse(string: &str) -> Result<Self, Error>

Implementors§

\ No newline at end of file diff --git a/actix_settings/type.Settings.html b/actix_settings/type.Settings.html index 41e8b53c4..9a56a2ac0 100644 --- a/actix_settings/type.Settings.html +++ b/actix_settings/type.Settings.html @@ -1,52 +1,7 @@ -Settings in actix_settings - Rust

Type Alias actix_settings::Settings

source · 
pub type Settings = BasicSettings<NoSettings>;
Expand description

Convenience type alias for BasicSettings with no defined application-specific settings.

+Settings in actix_settings - Rust

Type Alias actix_settings::Settings

source · 
pub type Settings = BasicSettings<NoSettings>;
Expand description

Convenience type alias for BasicSettings with no defined application-specific settings.

Aliased Type§

struct Settings {
     pub actix: ActixSettings,
     pub application: NoSettings,
 }

Fields§

§actix: ActixSettings

Actix Web server settings.

§application: NoSettings

Application-specific settings.

-

Implementations§

source§

impl<A> BasicSettings<A>where - A: DeserializeOwned,

source

pub fn parse_toml<P>(filepath: P) -> Result<Self, Error>where - P: AsRef<Path>,

Parse an instance of Self from a TOML file located at filepath.

-

If the file doesn’t exist, it is generated from the default TOML template, after which the -newly generated file is read in and parsed.

-
source

pub fn from_default_template() -> Result<Self, Error>

Parse an instance of Self straight from the default TOML template.

-
source

pub fn from_template(template: &str) -> Result<Self, Error>

Parse an instance of Self straight from the default TOML template.

-
source

pub fn write_toml_file<P>(filepath: P) -> Result<(), Error>where - P: AsRef<Path>,

Writes the default TOML template to a new file, located at filepath.

-
Errors
-

Returns a FileExists error if a file already exists at that -location.

-
source

pub fn override_field<F, V>(field: &mut F, value: V) -> Result<(), Error>where - F: Parse, - V: AsRef<str>,

Attempts to parse value and override the referenced field.

-
Examples
-
use actix_settings::{Settings, Mode};
-
-let mut settings = Settings::from_default_template()?;
-assert_eq!(settings.actix.mode, Mode::Development);
-
-Settings::override_field(&mut settings.actix.mode, "production")?;
-assert_eq!(settings.actix.mode, Mode::Production);
-
source

pub fn override_field_with_env_var<F, N>( - field: &mut F, - var_name: N -) -> Result<(), Error>where - F: Parse, - N: AsRef<str>,

Attempts to read an environment variable, parse it, and override the referenced field.

-
Examples
-
use actix_settings::{Settings, Mode};
-
-std::env::set_var("OVERRIDE__MODE", "production");
-
-let mut settings = Settings::from_default_template()?;
-assert_eq!(settings.actix.mode, Mode::Development);
-
-Settings::override_field_with_env_var(&mut settings.actix.mode, "OVERRIDE__MODE")?;
-assert_eq!(settings.actix.mode, Mode::Production);
-

Trait Implementations§

source§

impl<A: Clone> Clone for BasicSettings<A>

source§

fn clone(&self) -> BasicSettings<A>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<A: Debug> Debug for BasicSettings<A>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de, A> Deserialize<'de> for BasicSettings<A>where - A: Deserialize<'de>,

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where - __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<A: Hash> Hash for BasicSettings<A>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where - H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<A: PartialEq> PartialEq<BasicSettings<A>> for BasicSettings<A>

source§

fn eq(&self, other: &BasicSettings<A>) -> bool

This method tests for self and other values to be equal, and is used -by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
source§

impl<A: Eq> Eq for BasicSettings<A>

source§

impl<A> StructuralEq for BasicSettings<A>

source§

impl<A> StructuralPartialEq for BasicSettings<A>

\ No newline at end of file +
\ No newline at end of file diff --git a/actix_web_httpauth/all.html b/actix_web_httpauth/all.html index a7eb49567..3888ecbc6 100644 --- a/actix_web_httpauth/all.html +++ b/actix_web_httpauth/all.html @@ -1 +1 @@ -List of all items in this crate

List of all items

Structs

Enums

Traits

\ No newline at end of file +List of all items in this crate

List of all items

Structs

Enums

Traits

\ No newline at end of file diff --git a/actix_web_httpauth/extractors/basic/index.html b/actix_web_httpauth/extractors/basic/index.html index 4160234ab..f9b8f1b1d 100644 --- a/actix_web_httpauth/extractors/basic/index.html +++ b/actix_web_httpauth/extractors/basic/index.html @@ -1,2 +1,2 @@ -actix_web_httpauth::extractors::basic - Rust

Module actix_web_httpauth::extractors::basic

source ·
Expand description

Extractor for the “Basic” HTTP Authentication Scheme.

+actix_web_httpauth::extractors::basic - Rust

Module actix_web_httpauth::extractors::basic

source ·
Expand description

Extractor for the “Basic” HTTP Authentication Scheme.

Structs

\ No newline at end of file diff --git a/actix_web_httpauth/extractors/basic/struct.BasicAuth.html b/actix_web_httpauth/extractors/basic/struct.BasicAuth.html index 9e175e670..7ba8d116d 100644 --- a/actix_web_httpauth/extractors/basic/struct.BasicAuth.html +++ b/actix_web_httpauth/extractors/basic/struct.BasicAuth.html @@ -1,4 +1,4 @@ -BasicAuth in actix_web_httpauth::extractors::basic - Rust

Struct actix_web_httpauth::extractors::basic::BasicAuth

source · 
pub struct BasicAuth(/* private fields */);
Expand description

Extractor for HTTP Basic auth.

+BasicAuth in actix_web_httpauth::extractors::basic - Rust

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;
 
diff --git a/actix_web_httpauth/extractors/basic/struct.Config.html b/actix_web_httpauth/extractors/basic/struct.Config.html
index 1780f1421..ebd84ee47 100644
--- a/actix_web_httpauth/extractors/basic/struct.Config.html
+++ b/actix_web_httpauth/extractors/basic/struct.Config.html
@@ -1,4 +1,4 @@
-Config in actix_web_httpauth::extractors::basic - Rust
Struct actix_web_httpauth::extractors::basic::Config
source · 
pub struct Config(/* private fields */);
Expand description
BasicAuth extractor configuration used for WWW-Authenticate header later.

+Config in actix_web_httpauth::extractors::basic - Rust
Struct actix_web_httpauth::extractors::basic::Config
source · 
pub struct Config(/* private fields */);
Expand description
BasicAuth extractor configuration used for WWW-Authenticate header later.

 
Implementations§
source§
impl Config
source
pub fn realm<T>(self, value: T) -> Configwhere
     T: Into<Cow<'static, str>>,
Set challenge realm attribute.

 
The “realm” attribute indicates the scope of protection in the manner described in HTTP/1.1
diff --git a/actix_web_httpauth/extractors/bearer/enum.Error.html b/actix_web_httpauth/extractors/bearer/enum.Error.html
index c8f6bcd90..7210e9a44 100644
--- a/actix_web_httpauth/extractors/bearer/enum.Error.html
+++ b/actix_web_httpauth/extractors/bearer/enum.Error.html
@@ -1,4 +1,4 @@
-Error in actix_web_httpauth::extractors::bearer - Rust
Enum actix_web_httpauth::extractors::bearer::Error
source · 
pub enum Error {
+Error in actix_web_httpauth::extractors::bearer - Rust
Enum actix_web_httpauth::extractors::bearer::Error
source · 
pub enum Error {
     InvalidRequest,
     InvalidToken,
     InsufficientScope,
@@ -9,7 +9,7 @@ or is otherwise malformed.

 
§
InvalidToken
The access token provided is expired, revoked, malformed, or invalid for other reasons.

 
§
InsufficientScope
The request requires higher privileges than provided by the access token.

 
Implementations§
source§
impl Error
source
pub fn status_code(&self) -> StatusCode
Returns HTTP status code suitable for current error type.

-
Trait Implementations§
source§
impl Clone for Error
source§
fn clone(&self) -> Error
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for Error
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for Error
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Hash for Error
source§
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given Hasher. Read more
1.3.0 · source§
fn hash_slice<H>(data: &[Self], state: &mut H)where
+
Trait Implementations§
source§
impl Clone for Error
source§
fn clone(&self) -> Error
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for Error
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for Error
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Hash for Error
source§
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given Hasher. Read more
1.3.0 · source§
fn hash_slice<H>(data: &[Self], state: &mut H)where
     H: Hasher,
     Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§
impl Ord for Error
source§
fn cmp(&self, other: &Error) -> Ordering
This method returns an Ordering between self and other. Read more
1.21.0 · source§
fn max(self, other: Self) -> Selfwhere
     Self: Sized,
Compares and returns the maximum of two values. Read more
1.21.0 · source§
fn min(self, other: Self) -> Selfwhere
diff --git a/actix_web_httpauth/extractors/bearer/index.html b/actix_web_httpauth/extractors/bearer/index.html
index 868a312bc..789d9e28c 100644
--- a/actix_web_httpauth/extractors/bearer/index.html
+++ b/actix_web_httpauth/extractors/bearer/index.html
@@ -1,2 +1,2 @@
-actix_web_httpauth::extractors::bearer - Rust
Module actix_web_httpauth::extractors::bearer
source · 
Expand description
Extractor for the “Bearer” HTTP Authentication Scheme.

+actix_web_httpauth::extractors::bearer - Rust
Module actix_web_httpauth::extractors::bearer
source · 
Expand description
Extractor for the “Bearer” HTTP Authentication Scheme.

 
Structs
Enums

\ No newline at end of file
diff --git a/actix_web_httpauth/extractors/bearer/struct.BearerAuth.html b/actix_web_httpauth/extractors/bearer/struct.BearerAuth.html
index 59d9e597f..956331b65 100644
--- a/actix_web_httpauth/extractors/bearer/struct.BearerAuth.html
+++ b/actix_web_httpauth/extractors/bearer/struct.BearerAuth.html
@@ -1,4 +1,4 @@
-BearerAuth in actix_web_httpauth::extractors::bearer - Rust
Struct actix_web_httpauth::extractors::bearer::BearerAuth
source · 
pub struct BearerAuth(/* private fields */);
Expand description
Extractor for HTTP Bearer auth

+BearerAuth in actix_web_httpauth::extractors::bearer - Rust
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;
 
diff --git a/actix_web_httpauth/extractors/bearer/struct.Config.html b/actix_web_httpauth/extractors/bearer/struct.Config.html
index 739512bea..af6f72bdf 100644
--- a/actix_web_httpauth/extractors/bearer/struct.Config.html
+++ b/actix_web_httpauth/extractors/bearer/struct.Config.html
@@ -1,4 +1,4 @@
-Config in actix_web_httpauth::extractors::bearer - Rust
Struct actix_web_httpauth::extractors::bearer::Config
source · 
pub struct Config(/* private fields */);
Expand description
BearerAuth extractor configuration.

+Config in actix_web_httpauth::extractors::bearer - Rust
Struct actix_web_httpauth::extractors::bearer::Config
source · 
pub struct Config(/* private fields */);
Expand description
BearerAuth extractor configuration.

 
Implementations§
source§
impl Config
source
pub fn scope<T: Into<Cow<'static, str>>>(self, value: T) -> Config
Set challenge scope attribute.

 
The "scope" attribute is a space-delimited list of case-sensitive
 scope values indicating the required scope of the access token for
diff --git a/actix_web_httpauth/extractors/index.html b/actix_web_httpauth/extractors/index.html
index 5a1be0ff4..a348aa95c 100644
--- a/actix_web_httpauth/extractors/index.html
+++ b/actix_web_httpauth/extractors/index.html
@@ -1,3 +1,3 @@
-actix_web_httpauth::extractors - Rust
Module actix_web_httpauth::extractors
source · 
Expand description
Type-safe authentication information extractors.

+actix_web_httpauth::extractors - Rust
Module actix_web_httpauth::extractors
source · 
Expand description
Type-safe authentication information extractors.

 
Modules
  • basic
    Extractor for the “Basic” HTTP Authentication Scheme.
  • bearer
    Extractor for the “Bearer” HTTP Authentication Scheme.
Structs
Traits

\ No newline at end of file
diff --git a/actix_web_httpauth/extractors/struct.AuthenticationError.html b/actix_web_httpauth/extractors/struct.AuthenticationError.html
index 463a84d76..a2c9444d9 100644
--- a/actix_web_httpauth/extractors/struct.AuthenticationError.html
+++ b/actix_web_httpauth/extractors/struct.AuthenticationError.html
@@ -1,4 +1,4 @@
-AuthenticationError in actix_web_httpauth::extractors - Rust
Struct actix_web_httpauth::extractors::AuthenticationError
source · 
pub struct AuthenticationError<C: Challenge> { /* private fields */ }
Expand description
Authentication error returned by authentication extractors.

+AuthenticationError in actix_web_httpauth::extractors - Rust
Struct actix_web_httpauth::extractors::AuthenticationError
source · 
pub struct AuthenticationError<C: Challenge> { /* private fields */ }
Expand description
Authentication error returned by authentication extractors.

 
Different extractors may extend AuthenticationError implementation in order to provide access
 inner challenge fields.

 
Implementations§
source§
impl AuthenticationError<Bearer>
Extended error customization for HTTP Bearer auth.

diff --git a/actix_web_httpauth/extractors/trait.AuthExtractorConfig.html b/actix_web_httpauth/extractors/trait.AuthExtractorConfig.html
index e12b213b3..ba3bdf865 100644
--- a/actix_web_httpauth/extractors/trait.AuthExtractorConfig.html
+++ b/actix_web_httpauth/extractors/trait.AuthExtractorConfig.html
@@ -1,4 +1,4 @@
-AuthExtractorConfig in actix_web_httpauth::extractors - Rust
Trait actix_web_httpauth::extractors::AuthExtractorConfig
source · 
pub trait AuthExtractorConfig {
+AuthExtractorConfig in actix_web_httpauth::extractors - Rust
Trait actix_web_httpauth::extractors::AuthExtractorConfig
source · 
pub trait AuthExtractorConfig {
     type Inner: Challenge;
 
     // Required method
@@ -7,4 +7,4 @@
 extractors.

 
Required Associated Types§
source
type Inner: Challenge
Associated challenge type.

 
Required Methods§
source
fn into_inner(self) -> Self::Inner
Convert the config instance into a HTTP challenge.

-
Implementors§
source§
impl AuthExtractorConfig for actix_web_httpauth::extractors::basic::Config
§
type Inner = Basic
source§
impl AuthExtractorConfig for actix_web_httpauth::extractors::bearer::Config
§
type Inner = Bearer

\ No newline at end of file
+
Implementors§
source§
impl AuthExtractorConfig for actix_web_httpauth::extractors::basic::Config
§
type Inner = Basic
source§
impl AuthExtractorConfig for actix_web_httpauth::extractors::bearer::Config
§
type Inner = Bearer

\ No newline at end of file
diff --git a/actix_web_httpauth/headers/authorization/enum.ParseError.html b/actix_web_httpauth/headers/authorization/enum.ParseError.html
index 398846a60..7f9deca7a 100644
--- a/actix_web_httpauth/headers/authorization/enum.ParseError.html
+++ b/actix_web_httpauth/headers/authorization/enum.ParseError.html
@@ -1,4 +1,4 @@
-ParseError in actix_web_httpauth::headers::authorization - Rust
Enum actix_web_httpauth::headers::authorization::ParseError
source · 
pub enum ParseError {
+ParseError in actix_web_httpauth::headers::authorization - Rust
Enum actix_web_httpauth::headers::authorization::ParseError
source · 
pub enum ParseError {
     Invalid,
     MissingScheme,
     MissingField(&'static str),
@@ -14,7 +14,7 @@
 
§
ToStrError(ToStrError)
Unable to convert header into the str.

 
§
Base64DecodeError(DecodeError)
Malformed base64 string.

 
§
Utf8Error(Utf8Error)
Malformed UTF-8 string.

-
Trait Implementations§
source§
impl Debug for ParseError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for ParseError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for ParseError
source§
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
 Read more
1.0.0 · source§
fn cause(&self) -> Option<&dyn Error>
👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§
fn provide<'a>(&'a self, request: &mut Request<'a>)
🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§
impl From<DecodeError> for ParseError
source§
fn from(err: DecodeError) -> Self
Converts to this type from the input type.
source§
impl From<ToStrError> for ParseError
source§
fn from(err: ToStrError) -> Self
Converts to this type from the input type.
source§
impl From<Utf8Error> for ParseError
source§
fn from(err: Utf8Error) -> Self
Converts to this type from the input type.
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for Twhere
+
Trait Implementations§
source§
impl Debug for ParseError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for ParseError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for ParseError
source§
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
 Read more
1.0.0 · source§
fn cause(&self) -> Option<&dyn Error>
👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§
fn provide<'a>(&'a self, request: &mut Request<'a>)
🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§
impl From<DecodeError> for ParseError
source§
fn from(err: DecodeError) -> Self
Converts to this type from the input type.
source§
impl From<ToStrError> for ParseError
source§
fn from(err: ToStrError) -> Self
Converts to this type from the input type.
source§
impl From<Utf8Error> for ParseError
source§
fn from(err: Utf8Error) -> Self
Converts to this type from the input type.
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for Twhere
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for Twhere
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for Twhere
     T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

diff --git a/actix_web_httpauth/headers/authorization/index.html b/actix_web_httpauth/headers/authorization/index.html
index c6239a4ff..9b643ceb7 100644
--- a/actix_web_httpauth/headers/authorization/index.html
+++ b/actix_web_httpauth/headers/authorization/index.html
@@ -1,2 +1,2 @@
-actix_web_httpauth::headers::authorization - Rust
Module actix_web_httpauth::headers::authorization
source · 
Expand description
Authorization header and various auth schemes.

+actix_web_httpauth::headers::authorization - Rust
Module actix_web_httpauth::headers::authorization
source · 
Expand description
Authorization header and various auth schemes.

 
Structs
Enums
  • ParseError
    Possible errors while parsing Authorization header.
Traits

\ No newline at end of file
diff --git a/actix_web_httpauth/headers/authorization/struct.Authorization.html b/actix_web_httpauth/headers/authorization/struct.Authorization.html
index bff095dd5..8baf06e68 100644
--- a/actix_web_httpauth/headers/authorization/struct.Authorization.html
+++ b/actix_web_httpauth/headers/authorization/struct.Authorization.html
@@ -1,4 +1,4 @@
-Authorization in actix_web_httpauth::headers::authorization - Rust
Struct actix_web_httpauth::headers::authorization::Authorization
source · 
pub struct Authorization<S: Scheme>(/* private fields */);
Expand description
Authorization header, defined in RFC 7235

+Authorization in actix_web_httpauth::headers::authorization - Rust
Struct actix_web_httpauth::headers::authorization::Authorization
source · 
pub struct Authorization<S: Scheme>(/* private fields */);
Expand description
Authorization header, defined in RFC 7235

 
The “Authorization” header field allows a user agent to authenticate itself with an origin
 server—usually, but not necessarily, after receiving a 401 (Unauthorized) response. Its value
 consists of credentials containing the authentication information of the user agent for the
@@ -26,7 +26,7 @@ operator. UnwindSafe,
Blanket Implementations§
source§
impl<T> Any for Twhere
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for Twhere
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for Twhere
-    T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<!> for T
source§
fn from(t: !) -> T
Converts to this type from the input type.
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

+    T: ?Sized,
source§
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§
impl<T> From<!> for T
source§
fn from(t: !) -> T
Converts to this type from the input type.
source§
impl<T> From<T> for T
source§
fn from(t: T) -> T
Returns the argument unchanged.

 
§
impl<T> Instrument for T
§
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided [Span], returning an
 Instrumented wrapper. Read more
§
fn in_current_span(self) -> Instrumented<Self>
Instruments this type with the current Span, returning an
 Instrumented wrapper. Read more
source§
impl<T, U> Into<U> for Twhere
diff --git a/actix_web_httpauth/headers/authorization/struct.Basic.html b/actix_web_httpauth/headers/authorization/struct.Basic.html
index 71884a1f7..3719a3678 100644
--- a/actix_web_httpauth/headers/authorization/struct.Basic.html
+++ b/actix_web_httpauth/headers/authorization/struct.Basic.html
@@ -1,4 +1,4 @@
-Basic in actix_web_httpauth::headers::authorization - Rust
Struct actix_web_httpauth::headers::authorization::Basic
source · 
pub struct Basic { /* private fields */ }
Expand description
Credentials for Basic authentication scheme, defined in RFC 7617

+Basic in actix_web_httpauth::headers::authorization - Rust
Struct actix_web_httpauth::headers::authorization::Basic
source · 
pub struct Basic { /* private fields */ }
Expand description
Credentials for Basic authentication scheme, defined in RFC 7617

 
Implementations§
source§
impl Basic
source
pub fn new<U, P>(user_id: U, password: Option<P>) -> Basicwhere
     U: Into<Cow<'static, str>>,
     P: Into<Cow<'static, str>>,
Creates Basic credentials with provided user_id and optional
@@ -7,7 +7,7 @@
 
let credentials = Basic::new("Alladin", Some("open sesame"));

 
source
pub fn user_id(&self) -> &str
Returns client’s user-ID.

 
source
pub fn password(&self) -> Option<&str>
Returns client’s password if provided.

-
Trait Implementations§
source§
impl Clone for Basic
source§
fn clone(&self) -> Basic
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for Basic
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for Basic
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl From<Basic> for BasicAuth
source§
fn from(basic: Basic) -> Self
Converts to this type from the input type.
source§
impl Ord for Basic
source§
fn cmp(&self, other: &Basic) -> Ordering
This method returns an Ordering between self and other. Read more
1.21.0 · source§
fn max(self, other: Self) -> Selfwhere
+
Trait Implementations§
source§
impl Clone for Basic
source§
fn clone(&self) -> Basic
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for Basic
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for Basic
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl From<Basic> for BasicAuth
source§
fn from(basic: Basic) -> Self
Converts to this type from the input type.
source§
impl Ord for Basic
source§
fn cmp(&self, other: &Basic) -> Ordering
This method returns an Ordering between self and other. Read more
1.21.0 · source§
fn max(self, other: Self) -> Selfwhere
     Self: Sized,
Compares and returns the maximum of two values. Read more
1.21.0 · source§
fn min(self, other: Self) -> Selfwhere
     Self: Sized,
Compares and returns the minimum of two values. Read more
1.50.0 · source§
fn clamp(self, min: Self, max: Self) -> Selfwhere
     Self: Sized + PartialOrd<Self>,
Restrict a value to a certain interval. Read more
source§
impl PartialEq<Basic> for Basic
source§
fn eq(&self, other: &Basic) -> bool
This method tests for self and other values to be equal, and is used
diff --git a/actix_web_httpauth/headers/authorization/struct.Bearer.html b/actix_web_httpauth/headers/authorization/struct.Bearer.html
index d9da903d7..321ca8940 100644
--- a/actix_web_httpauth/headers/authorization/struct.Bearer.html
+++ b/actix_web_httpauth/headers/authorization/struct.Bearer.html
@@ -1,11 +1,11 @@
-Bearer in actix_web_httpauth::headers::authorization - Rust
Struct actix_web_httpauth::headers::authorization::Bearer
source · 
pub struct Bearer { /* private fields */ }
Expand description
Credentials for Bearer authentication scheme, defined in RFC 6750.

+Bearer in actix_web_httpauth::headers::authorization - Rust
Struct actix_web_httpauth::headers::authorization::Bearer
source · 
pub struct Bearer { /* private fields */ }
Expand description
Credentials for Bearer authentication scheme, defined in RFC 6750.

 
Should be used in combination with Authorization header.

 
Implementations§
source§
impl Bearer
source
pub fn new<T>(token: T) -> Bearerwhere
     T: Into<Cow<'static, str>>,
Creates new Bearer credentials with the token provided.

 
Example

 
let credentials = Bearer::new("mF_9.B5f-4.1JqM");

 
source
pub fn token(&self) -> &str
Gets reference to the credentials token.

-
Trait Implementations§
source§
impl Clone for Bearer
source§
fn clone(&self) -> Bearer
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for Bearer
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for Bearer
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Ord for Bearer
source§
fn cmp(&self, other: &Bearer) -> Ordering
This method returns an Ordering between self and other. Read more
1.21.0 · source§
fn max(self, other: Self) -> Selfwhere
+
Trait Implementations§
source§
impl Clone for Bearer
source§
fn clone(&self) -> Bearer
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for Bearer
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for Bearer
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Ord for Bearer
source§
fn cmp(&self, other: &Bearer) -> Ordering
This method returns an Ordering between self and other. Read more
1.21.0 · source§
fn max(self, other: Self) -> Selfwhere
     Self: Sized,
Compares and returns the maximum of two values. Read more
1.21.0 · source§
fn min(self, other: Self) -> Selfwhere
     Self: Sized,
Compares and returns the minimum of two values. Read more
1.50.0 · source§
fn clamp(self, min: Self, max: Self) -> Selfwhere
     Self: Sized + PartialOrd<Self>,
Restrict a value to a certain interval. Read more
source§
impl PartialEq<Bearer> for Bearer
source§
fn eq(&self, other: &Bearer) -> bool
This method tests for self and other values to be equal, and is used
diff --git a/actix_web_httpauth/headers/authorization/trait.Scheme.html b/actix_web_httpauth/headers/authorization/trait.Scheme.html
index 84ccf10d1..93459525d 100644
--- a/actix_web_httpauth/headers/authorization/trait.Scheme.html
+++ b/actix_web_httpauth/headers/authorization/trait.Scheme.html
@@ -1,6 +1,6 @@
-Scheme in actix_web_httpauth::headers::authorization - Rust
Trait actix_web_httpauth::headers::authorization::Scheme
source · 
pub trait Scheme: TryIntoHeaderValue + Debug + Display + Clone + Send + Sync {
+Scheme in actix_web_httpauth::headers::authorization - Rust
Trait actix_web_httpauth::headers::authorization::Scheme
source · 
pub trait Scheme: TryIntoHeaderValue + Debug + Display + Clone + Send + Sync {
     // Required method
     fn parse(header: &HeaderValue) -> Result<Self, ParseError>;
 }
Expand description
Authentication scheme for Authorization header.

 
Required Methods§
source
fn parse(header: &HeaderValue) -> Result<Self, ParseError>
Try to parse an authentication scheme from the Authorization header.

-
Implementors§

\ No newline at end of file
+
Implementors§

\ No newline at end of file
diff --git a/actix_web_httpauth/headers/index.html b/actix_web_httpauth/headers/index.html
index 1bcfb074a..fa02ff9c2 100644
--- a/actix_web_httpauth/headers/index.html
+++ b/actix_web_httpauth/headers/index.html
@@ -1,2 +1,2 @@
-actix_web_httpauth::headers - Rust
Module actix_web_httpauth::headers
source · 
Expand description
Typed HTTP headers.

+actix_web_httpauth::headers - Rust
Module actix_web_httpauth::headers
source · 
Expand description
Typed HTTP headers.

 
Modules

\ No newline at end of file
diff --git a/actix_web_httpauth/headers/www_authenticate/basic/index.html b/actix_web_httpauth/headers/www_authenticate/basic/index.html
index f6078c52a..93bdd5c6f 100644
--- a/actix_web_httpauth/headers/www_authenticate/basic/index.html
+++ b/actix_web_httpauth/headers/www_authenticate/basic/index.html
@@ -1,3 +1,3 @@
-actix_web_httpauth::headers::www_authenticate::basic - Rust
Module actix_web_httpauth::headers::www_authenticate::basic
source · 
Expand description
Challenge for the “Basic” HTTP Authentication Scheme.

+actix_web_httpauth::headers::www_authenticate::basic - Rust
Module actix_web_httpauth::headers::www_authenticate::basic
source · 
Expand description
Challenge for the “Basic” HTTP Authentication Scheme.

 
Structs

\ No newline at end of file
diff --git a/actix_web_httpauth/headers/www_authenticate/basic/struct.Basic.html b/actix_web_httpauth/headers/www_authenticate/basic/struct.Basic.html
index 684ef1a45..e16320a9f 100644
--- a/actix_web_httpauth/headers/www_authenticate/basic/struct.Basic.html
+++ b/actix_web_httpauth/headers/www_authenticate/basic/struct.Basic.html
@@ -1,4 +1,4 @@
-Basic in actix_web_httpauth::headers::www_authenticate::basic - Rust
Struct actix_web_httpauth::headers::www_authenticate::basic::Basic
source · 
pub struct Basic { /* private fields */ }
Expand description
Challenge for WWW-Authenticate header with HTTP Basic auth scheme,
+Basic in actix_web_httpauth::headers::www_authenticate::basic - Rust
Struct actix_web_httpauth::headers::www_authenticate::basic::Basic
source · 
pub struct Basic { /* private fields */ }
Expand description
Challenge for WWW-Authenticate header with HTTP Basic auth scheme,
 described in RFC 7617

 
Examples

 
use actix_web_httpauth::headers::www_authenticate::basic::Basic;
diff --git a/actix_web_httpauth/headers/www_authenticate/bearer/enum.Error.html b/actix_web_httpauth/headers/www_authenticate/bearer/enum.Error.html
index 2dbb3e958..f5d0ba432 100644
--- a/actix_web_httpauth/headers/www_authenticate/bearer/enum.Error.html
+++ b/actix_web_httpauth/headers/www_authenticate/bearer/enum.Error.html
@@ -1,4 +1,4 @@
-Error in actix_web_httpauth::headers::www_authenticate::bearer - Rust
Enum actix_web_httpauth::headers::www_authenticate::bearer::Error
source · 
pub enum Error {
+Error in actix_web_httpauth::headers::www_authenticate::bearer - Rust
Enum actix_web_httpauth::headers::www_authenticate::bearer::Error
source · 
pub enum Error {
     InvalidRequest,
     InvalidToken,
     InsufficientScope,
@@ -9,7 +9,7 @@ or is otherwise malformed.

 
§
InvalidToken
The access token provided is expired, revoked, malformed, or invalid for other reasons.

 
§
InsufficientScope
The request requires higher privileges than provided by the access token.

 
Implementations§
source§
impl Error
source
pub fn status_code(&self) -> StatusCode
Returns HTTP status code suitable for current error type.

-
Trait Implementations§
source§
impl Clone for Error
source§
fn clone(&self) -> Error
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for Error
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for Error
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Hash for Error
source§
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given Hasher. Read more
1.3.0 · source§
fn hash_slice<H>(data: &[Self], state: &mut H)where
+
Trait Implementations§
source§
impl Clone for Error
source§
fn clone(&self) -> Error
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl Debug for Error
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for Error
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Hash for Error
source§
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given Hasher. Read more
1.3.0 · source§
fn hash_slice<H>(data: &[Self], state: &mut H)where
     H: Hasher,
     Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source§
impl Ord for Error
source§
fn cmp(&self, other: &Error) -> Ordering
This method returns an Ordering between self and other. Read more
1.21.0 · source§
fn max(self, other: Self) -> Selfwhere
     Self: Sized,
Compares and returns the maximum of two values. Read more
1.21.0 · source§
fn min(self, other: Self) -> Selfwhere
diff --git a/actix_web_httpauth/headers/www_authenticate/bearer/index.html b/actix_web_httpauth/headers/www_authenticate/bearer/index.html
index ddf88e7f6..359f55f56 100644
--- a/actix_web_httpauth/headers/www_authenticate/bearer/index.html
+++ b/actix_web_httpauth/headers/www_authenticate/bearer/index.html
@@ -1,2 +1,2 @@
-actix_web_httpauth::headers::www_authenticate::bearer - Rust
Module actix_web_httpauth::headers::www_authenticate::bearer
source · 
Expand description
Challenge for the “Bearer” HTTP Authentication Scheme.

+actix_web_httpauth::headers::www_authenticate::bearer - Rust
Module actix_web_httpauth::headers::www_authenticate::bearer
source · 
Expand description
Challenge for the “Bearer” HTTP Authentication Scheme.

 
Structs
Enums

\ No newline at end of file
diff --git a/actix_web_httpauth/headers/www_authenticate/bearer/struct.Bearer.html b/actix_web_httpauth/headers/www_authenticate/bearer/struct.Bearer.html
index 7ec553b0a..d9e328835 100644
--- a/actix_web_httpauth/headers/www_authenticate/bearer/struct.Bearer.html
+++ b/actix_web_httpauth/headers/www_authenticate/bearer/struct.Bearer.html
@@ -1,4 +1,4 @@
-Bearer in actix_web_httpauth::headers::www_authenticate::bearer - Rust
Struct actix_web_httpauth::headers::www_authenticate::bearer::Bearer
source · 
pub struct Bearer { /* private fields */ }
Expand description
Challenge for WWW-Authenticate header with HTTP Bearer auth scheme, described in RFC 6750.

+Bearer in actix_web_httpauth::headers::www_authenticate::bearer - Rust
Struct actix_web_httpauth::headers::www_authenticate::bearer::Bearer
source · 
pub struct Bearer { /* private fields */ }
Expand description
Challenge for WWW-Authenticate header with HTTP Bearer auth scheme, described in RFC 6750.

 
Examples

 
use actix_web_httpauth::headers::www_authenticate::bearer::{
     Bearer, Error,
diff --git a/actix_web_httpauth/headers/www_authenticate/bearer/struct.BearerBuilder.html b/actix_web_httpauth/headers/www_authenticate/bearer/struct.BearerBuilder.html
index a29ddf711..734435099 100644
--- a/actix_web_httpauth/headers/www_authenticate/bearer/struct.BearerBuilder.html
+++ b/actix_web_httpauth/headers/www_authenticate/bearer/struct.BearerBuilder.html
@@ -1,4 +1,4 @@
-BearerBuilder in actix_web_httpauth::headers::www_authenticate::bearer - Rust
Struct actix_web_httpauth::headers::www_authenticate::bearer::BearerBuilder
source · 
pub struct BearerBuilder(/* private fields */);
Expand description
Builder for the Bearer challenge.

+BearerBuilder in actix_web_httpauth::headers::www_authenticate::bearer - Rust
Struct actix_web_httpauth::headers::www_authenticate::bearer::BearerBuilder
source · 
pub struct BearerBuilder(/* private fields */);
Expand description
Builder for the Bearer challenge.

 
It is up to implementor to fill all required fields, neither this Builder nor Bearer
 provide any validation.

 
Implementations§
source§
impl BearerBuilder
source
pub fn scope<T>(self, value: T) -> Selfwhere
diff --git a/actix_web_httpauth/headers/www_authenticate/index.html b/actix_web_httpauth/headers/www_authenticate/index.html
index 54fe15963..c26d11cd5 100644
--- a/actix_web_httpauth/headers/www_authenticate/index.html
+++ b/actix_web_httpauth/headers/www_authenticate/index.html
@@ -1,2 +1,2 @@
-actix_web_httpauth::headers::www_authenticate - Rust
Module actix_web_httpauth::headers::www_authenticate
source · 
Expand description
WWW-Authenticate header and various auth challenges.

+actix_web_httpauth::headers::www_authenticate - Rust
Module actix_web_httpauth::headers::www_authenticate
source · 
Expand description
WWW-Authenticate header and various auth challenges.

 
Modules
  • basic
    Challenge for the “Basic” HTTP Authentication Scheme.
  • bearer
    Challenge for the “Bearer” HTTP Authentication Scheme.
Structs
Traits
  • Challenge
    Authentication challenge for WWW-Authenticate header.

\ No newline at end of file
diff --git a/actix_web_httpauth/headers/www_authenticate/struct.WwwAuthenticate.html b/actix_web_httpauth/headers/www_authenticate/struct.WwwAuthenticate.html
index 176ac8fc3..bfeb70532 100644
--- a/actix_web_httpauth/headers/www_authenticate/struct.WwwAuthenticate.html
+++ b/actix_web_httpauth/headers/www_authenticate/struct.WwwAuthenticate.html
@@ -1,4 +1,4 @@
-WwwAuthenticate in actix_web_httpauth::headers::www_authenticate - Rust
Struct actix_web_httpauth::headers::www_authenticate::WwwAuthenticate
source · 
pub struct WwwAuthenticate<C: Challenge>(pub C);
Expand description
WWW-Authenticate header, described in RFC 7235.

+WwwAuthenticate in actix_web_httpauth::headers::www_authenticate - Rust
Struct actix_web_httpauth::headers::www_authenticate::WwwAuthenticate
source · 
pub struct WwwAuthenticate<C: Challenge>(pub C);
Expand description
WWW-Authenticate header, described in RFC 7235.

 
This header is generic over the Challenge trait, see Basic and
 Bearer challenges for details.

 
Tuple Fields§
§0: C
Trait Implementations§
source§
impl<C: Clone + Challenge> Clone for WwwAuthenticate<C>
source§
fn clone(&self) -> WwwAuthenticate<C>
Returns a copy of the value. Read more
1.0.0 · source§
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source§
impl<C: Debug + Challenge> Debug for WwwAuthenticate<C>
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl<C: Default + Challenge> Default for WwwAuthenticate<C>
source§
fn default() -> WwwAuthenticate<C>
Returns the “default value” for a type. Read more
source§
impl<C: Hash + Challenge> Hash for WwwAuthenticate<C>
source§
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given Hasher. Read more
1.3.0 · source§
fn hash_slice<H>(data: &[Self], state: &mut H)where
diff --git a/actix_web_httpauth/headers/www_authenticate/trait.Challenge.html b/actix_web_httpauth/headers/www_authenticate/trait.Challenge.html
index 00e6ff3bd..0e0a25435 100644
--- a/actix_web_httpauth/headers/www_authenticate/trait.Challenge.html
+++ b/actix_web_httpauth/headers/www_authenticate/trait.Challenge.html
@@ -1,6 +1,6 @@
-Challenge in actix_web_httpauth::headers::www_authenticate - Rust
Trait actix_web_httpauth::headers::www_authenticate::Challenge
source · 
pub trait Challenge: TryIntoHeaderValue + Debug + Display + Clone + Send + Sync {
+Challenge in actix_web_httpauth::headers::www_authenticate - Rust
Trait actix_web_httpauth::headers::www_authenticate::Challenge
source · 
pub trait Challenge: TryIntoHeaderValue + Debug + Display + Clone + Send + Sync {
     // Required method
     fn to_bytes(&self) -> Bytes;
 }
Expand description
Authentication challenge for WWW-Authenticate header.

 
Required Methods§
source
fn to_bytes(&self) -> Bytes
Converts the challenge into a bytes suitable for HTTP transmission.

-
Implementors§

\ No newline at end of file
+
Implementors§

\ No newline at end of file
diff --git a/actix_web_httpauth/index.html b/actix_web_httpauth/index.html
index b9e1f68d0..c6178d873 100644
--- a/actix_web_httpauth/index.html
+++ b/actix_web_httpauth/index.html
@@ -1,4 +1,4 @@
-actix_web_httpauth - Rust