From 48b1efd901d5b454dd100606c5b70103b62c6d3f Mon Sep 17 00:00:00 2001 From: "github-merge-queue[bot]" Date: Thu, 15 Feb 2024 10:18:22 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20actix/ac?= =?UTF-8?q?tix-extras@5414e2655bdc51d34b22a901cacea3e995fdb130=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- actix_cors/all.html | 2 +- actix_cors/enum.CorsError.html | 2 +- actix_cors/index.html | 2 +- actix_cors/struct.Cors.html | 2 +- actix_identity/all.html | 2 +- .../config/enum.LogoutBehaviour.html | 6 +-- actix_identity/config/index.html | 4 +- .../struct.IdentityMiddlewareBuilder.html | 17 ++++--- .../error/enum.GetIdentityError.html | 8 +-- actix_identity/error/index.html | 2 +- actix_identity/error/struct.LoginError.html | 4 +- .../error/struct.LostIdentityError.html | 2 +- .../error/struct.MissingIdentityError.html | 2 +- .../error/struct.SessionExpiryError.html | 2 +- actix_identity/index.html | 2 +- actix_identity/struct.Identity.html | 12 ++--- actix_identity/struct.IdentityMiddleware.html | 2 +- actix_identity/trait.IdentityExt.html | 2 +- actix_limitation/all.html | 2 +- .../constant.DEFAULT_COOKIE_NAME.html | 2 +- .../constant.DEFAULT_PERIOD_SECS.html | 2 +- .../constant.DEFAULT_REQUEST_LIMIT.html | 2 +- .../constant.DEFAULT_SESSION_KEY.html | 2 +- actix_limitation/enum.Error.html | 4 +- actix_limitation/index.html | 2 +- actix_limitation/struct.Builder.html | 2 +- actix_limitation/struct.Limiter.html | 2 +- actix_limitation/struct.RateLimiter.html | 2 +- actix_limitation/struct.Status.html | 2 +- actix_protobuf/all.html | 2 +- actix_protobuf/enum.ProtoBufPayloadError.html | 2 +- actix_protobuf/index.html | 2 +- actix_protobuf/struct.ProtoBuf.html | 2 +- actix_protobuf/struct.ProtoBufConfig.html | 2 +- actix_protobuf/struct.ProtoBufMessage.html | 2 +- .../trait.ProtoBufResponseBuilder.html | 2 +- actix_redis/all.html | 2 +- actix_redis/enum.Error.html | 4 +- actix_redis/enum.RespError.html | 4 +- actix_redis/enum.RespValue.html | 4 +- actix_redis/index.html | 2 +- actix_redis/macro.resp_array.html | 2 +- actix_redis/struct.Command.html | 2 +- actix_redis/struct.RedisActor.html | 8 +-- actix_session/all.html | 2 +- .../config/enum.CookieContentSecurity.html | 2 +- .../config/enum.SessionLifecycle.html | 2 +- .../config/enum.TtlExtensionPolicy.html | 2 +- actix_session/config/index.html | 2 +- .../config/struct.BrowserSession.html | 2 +- .../config/struct.PersistentSession.html | 2 +- .../struct.SessionMiddlewareBuilder.html | 2 +- actix_session/enum.SessionStatus.html | 2 +- actix_session/index.html | 2 +- actix_session/storage/enum.LoadError.html | 2 +- actix_session/storage/enum.SaveError.html | 4 +- actix_session/storage/enum.UpdateError.html | 4 +- actix_session/storage/index.html | 2 +- .../storage/struct.CookieSessionStore.html | 2 +- .../struct.RedisActorSessionStore.html | 2 +- .../struct.RedisActorSessionStoreBuilder.html | 2 +- .../storage/struct.RedisSessionStore.html | 2 +- .../struct.RedisSessionStoreBuilder.html | 2 +- actix_session/storage/struct.SessionKey.html | 2 +- actix_session/storage/trait.SessionStore.html | 2 +- actix_session/struct.Session.html | 2 +- actix_session/struct.SessionGetError.html | 4 +- actix_session/struct.SessionInsertError.html | 2 +- actix_session/struct.SessionMiddleware.html | 2 +- actix_session/trait.SessionExt.html | 2 +- actix_settings/all.html | 2 +- actix_settings/enum.Backlog.html | 2 +- actix_settings/enum.Error.html | 4 +- actix_settings/enum.KeepAlive.html | 2 +- actix_settings/enum.MaxConnectionRate.html | 2 +- actix_settings/enum.MaxConnections.html | 2 +- actix_settings/enum.Mode.html | 2 +- actix_settings/enum.NumWorkers.html | 2 +- actix_settings/enum.Timeout.html | 2 +- actix_settings/index.html | 2 +- actix_settings/struct.ActixSettings.html | 2 +- actix_settings/struct.Address.html | 2 +- actix_settings/struct.BasicSettings.html | 2 +- actix_settings/struct.NoSettings.html | 2 +- actix_settings/struct.Tls.html | 2 +- actix_settings/trait.ApplySettings.html | 2 +- actix_settings/trait.Parse.html | 2 +- actix_settings/type.Settings.html | 2 +- actix_web_httpauth/all.html | 2 +- .../extractors/basic/index.html | 2 +- .../extractors/basic/struct.BasicAuth.html | 2 +- .../extractors/basic/struct.Config.html | 2 +- .../extractors/bearer/enum.Error.html | 2 +- .../extractors/bearer/index.html | 2 +- .../extractors/bearer/struct.BearerAuth.html | 2 +- .../extractors/bearer/struct.Config.html | 2 +- actix_web_httpauth/extractors/index.html | 2 +- .../struct.AuthenticationError.html | 2 +- .../extractors/trait.AuthExtractorConfig.html | 2 +- .../authorization/enum.ParseError.html | 4 +- .../headers/authorization/index.html | 2 +- .../authorization/struct.Authorization.html | 4 +- .../headers/authorization/struct.Basic.html | 2 +- .../headers/authorization/struct.Bearer.html | 2 +- .../headers/authorization/trait.Scheme.html | 2 +- actix_web_httpauth/headers/index.html | 2 +- .../headers/www_authenticate/basic/index.html | 2 +- .../www_authenticate/basic/struct.Basic.html | 2 +- .../www_authenticate/bearer/enum.Error.html | 2 +- .../www_authenticate/bearer/index.html | 2 +- .../bearer/struct.Bearer.html | 4 +- .../bearer/struct.BearerBuilder.html | 2 +- .../headers/www_authenticate/index.html | 2 +- .../struct.WwwAuthenticate.html | 2 +- .../www_authenticate/trait.Challenge.html | 2 +- actix_web_httpauth/index.html | 2 +- actix_web_httpauth/middleware/index.html | 2 +- .../middleware/struct.HttpAuthentication.html | 2 +- actix_ws/all.html | 2 +- actix_ws/enum.CloseCode.html | 2 +- actix_ws/enum.Message.html | 2 +- actix_ws/enum.ProtocolError.html | 4 +- actix_ws/fn.handle.html | 2 +- actix_ws/index.html | 2 +- actix_ws/struct.CloseReason.html | 4 +- actix_ws/struct.Closed.html | 4 +- actix_ws/struct.MessageStream.html | 2 +- actix_ws/struct.Session.html | 2 +- actix_ws/struct.StreamingBody.html | 2 +- help.html | 4 +- search-index.js | 16 +++--- settings.html | 4 +- src/actix_cors/all_or_some.rs.html | 2 +- src/actix_cors/builder.rs.html | 2 +- src/actix_cors/error.rs.html | 2 +- src/actix_cors/inner.rs.html | 2 +- src/actix_cors/lib.rs.html | 2 +- src/actix_cors/middleware.rs.html | 2 +- src/actix_identity/config.rs.html | 50 ++++++++++++++++++- src/actix_identity/error.rs.html | 2 +- src/actix_identity/identity.rs.html | 38 ++++++++------ src/actix_identity/identity_ext.rs.html | 2 +- src/actix_identity/lib.rs.html | 2 +- src/actix_identity/middleware.rs.html | 8 ++- src/actix_limitation/builder.rs.html | 2 +- src/actix_limitation/errors.rs.html | 2 +- src/actix_limitation/lib.rs.html | 2 +- src/actix_limitation/middleware.rs.html | 2 +- src/actix_limitation/status.rs.html | 2 +- src/actix_protobuf/lib.rs.html | 2 +- src/actix_redis/lib.rs.html | 2 +- src/actix_redis/redis.rs.html | 2 +- src/actix_session/config.rs.html | 2 +- src/actix_session/lib.rs.html | 2 +- src/actix_session/middleware.rs.html | 2 +- src/actix_session/session.rs.html | 2 +- src/actix_session/session_ext.rs.html | 2 +- src/actix_session/storage/cookie.rs.html | 2 +- src/actix_session/storage/interface.rs.html | 2 +- src/actix_session/storage/mod.rs.html | 2 +- src/actix_session/storage/redis_actor.rs.html | 2 +- src/actix_session/storage/redis_rs.rs.html | 2 +- src/actix_session/storage/session_key.rs.html | 2 +- src/actix_session/storage/utils.rs.html | 2 +- src/actix_settings/error.rs.html | 2 +- src/actix_settings/lib.rs.html | 2 +- src/actix_settings/parse.rs.html | 2 +- src/actix_settings/settings/address.rs.html | 2 +- src/actix_settings/settings/backlog.rs.html | 2 +- .../settings/keep_alive.rs.html | 2 +- .../settings/max_connection_rate.rs.html | 2 +- .../settings/max_connections.rs.html | 2 +- src/actix_settings/settings/mod.rs.html | 2 +- src/actix_settings/settings/mode.rs.html | 2 +- .../settings/num_workers.rs.html | 2 +- src/actix_settings/settings/timeout.rs.html | 2 +- src/actix_settings/settings/tls.rs.html | 2 +- .../extractors/basic.rs.html | 2 +- .../extractors/bearer.rs.html | 2 +- .../extractors/config.rs.html | 2 +- .../extractors/errors.rs.html | 2 +- src/actix_web_httpauth/extractors/mod.rs.html | 2 +- .../headers/authorization/errors.rs.html | 2 +- .../headers/authorization/header.rs.html | 2 +- .../headers/authorization/mod.rs.html | 2 +- .../authorization/scheme/basic.rs.html | 2 +- .../authorization/scheme/bearer.rs.html | 2 +- .../headers/authorization/scheme/mod.rs.html | 2 +- src/actix_web_httpauth/headers/mod.rs.html | 2 +- .../www_authenticate/challenge/basic.rs.html | 2 +- .../challenge/bearer/builder.rs.html | 2 +- .../challenge/bearer/challenge.rs.html | 2 +- .../challenge/bearer/errors.rs.html | 2 +- .../challenge/bearer/mod.rs.html | 2 +- .../www_authenticate/challenge/mod.rs.html | 2 +- .../headers/www_authenticate/header.rs.html | 2 +- .../headers/www_authenticate/mod.rs.html | 2 +- src/actix_web_httpauth/lib.rs.html | 2 +- src/actix_web_httpauth/middleware.rs.html | 2 +- src/actix_web_httpauth/utils.rs.html | 2 +- src/actix_ws/fut.rs.html | 2 +- src/actix_ws/lib.rs.html | 2 +- src/actix_ws/session.rs.html | 2 +- trait.impl/core/convert/trait.From.js | 2 +- 204 files changed, 326 insertions(+), 263 deletions(-) diff --git a/actix_cors/all.html b/actix_cors/all.html index f41025224..4c37a9f72 100644 --- a/actix_cors/all.html +++ b/actix_cors/all.html @@ -1,2 +1,2 @@ -List of all items in this crate
+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 b2fbf0088..c1c3138e1 100644 --- a/actix_cors/enum.CorsError.html +++ b/actix_cors/enum.CorsError.html @@ -1,4 +1,4 @@ -CorsError in actix_cors - Rust
+CorsError in actix_cors - Rust

Enum actix_cors::CorsError

source · 
#[non_exhaustive]
pub enum CorsError {
     WildcardOrigin,
     MissingOrigin,
diff --git a/actix_cors/index.html b/actix_cors/index.html
index d07667264..69fed5f59 100644
--- a/actix_cors/index.html
+++ b/actix_cors/index.html
@@ -1,4 +1,4 @@
-actix_cors - Rust
-
source

pub fn logout(self)

Remove the user identity from the current session.

+
source

pub fn logout(self)

Remove the user identity from the current session.

After logout has been called, the user will no longer be able to access routes that require a valid Identity.

The behaviour on logout is determined by IdentityMiddlewareBuilder::logout_behaviour.

@@ -89,7 +89,7 @@ require a valid Trait Implementations§
source§

impl FromRequest for Identity

Extractor implementation for Identity.

+

Trait Implementations§

source§

impl FromRequest for Identity

Extractor implementation for Identity.

§Examples

use actix_web::{get, Responder};
 use actix_identity::Identity;
@@ -102,7 +102,7 @@ require a valid "Welcome Anonymous!".to_owned()
     }
 }
-
§

type Error = Error

The associated error which can be returned.
§

type Future = Ready<Result<Identity, <Identity as FromRequest>::Error>>

Future that resolves to a Self. Read more
source§

fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.
§

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +
§

type Error = Error

The associated error which can be returned.
§

type Future = Ready<Result<Identity, <Identity as FromRequest>::Error>>

Future that resolves to a Self. Read more
source§

fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.
§

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where 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_identity/struct.IdentityMiddleware.html b/actix_identity/struct.IdentityMiddleware.html index 920e94238..c539a043d 100644 --- a/actix_identity/struct.IdentityMiddleware.html +++ b/actix_identity/struct.IdentityMiddleware.html @@ -1,4 +1,4 @@ -IdentityMiddleware in actix_identity - Rust
+IdentityMiddleware in actix_identity - Rust

Struct actix_identity::IdentityMiddleware

source · 
pub struct IdentityMiddleware { /* private fields */ }
Expand description

Identity management middleware.

use actix_web::{cookie::Key, App, HttpServer};
diff --git a/actix_identity/trait.IdentityExt.html b/actix_identity/trait.IdentityExt.html
index 862edfc67..a585c086c 100644
--- a/actix_identity/trait.IdentityExt.html
+++ b/actix_identity/trait.IdentityExt.html
@@ -1,4 +1,4 @@
-IdentityExt in actix_identity - Rust

+IdentityExt in actix_identity - Rust

     
Trait actix_identity::IdentityExt
source · 
pub trait IdentityExt {
     // Required method
     fn get_identity(&self) -> Result<Identity, GetIdentityError>;
diff --git a/actix_limitation/all.html b/actix_limitation/all.html
index 11f0d32e2..074b59828 100644
--- a/actix_limitation/all.html
+++ b/actix_limitation/all.html
@@ -1,2 +1,2 @@
-List of all items in this crate

+List of all items in this crate

     
List of all items
Structs
Enums
Constants

\ No newline at end of file
diff --git a/actix_limitation/constant.DEFAULT_COOKIE_NAME.html b/actix_limitation/constant.DEFAULT_COOKIE_NAME.html
index 1b747cefe..539ac081c 100644
--- a/actix_limitation/constant.DEFAULT_COOKIE_NAME.html
+++ b/actix_limitation/constant.DEFAULT_COOKIE_NAME.html
@@ -1,3 +1,3 @@
-DEFAULT_COOKIE_NAME in actix_limitation - Rust

+DEFAULT_COOKIE_NAME in actix_limitation - Rust

     
Constant actix_limitation::DEFAULT_COOKIE_NAME
source · 
pub const DEFAULT_COOKIE_NAME: &str = "sid";
Expand description
Default cookie name.

 

\ No newline at end of file
diff --git a/actix_limitation/constant.DEFAULT_PERIOD_SECS.html b/actix_limitation/constant.DEFAULT_PERIOD_SECS.html
index 07245b5be..292de9c01 100644
--- a/actix_limitation/constant.DEFAULT_PERIOD_SECS.html
+++ b/actix_limitation/constant.DEFAULT_PERIOD_SECS.html
@@ -1,3 +1,3 @@
-DEFAULT_PERIOD_SECS in actix_limitation - Rust

+DEFAULT_PERIOD_SECS in actix_limitation - Rust

     
Constant actix_limitation::DEFAULT_PERIOD_SECS
source · 
pub const DEFAULT_PERIOD_SECS: u64 = 3600;
Expand description
Default period (in seconds).

 

\ No newline at end of file
diff --git a/actix_limitation/constant.DEFAULT_REQUEST_LIMIT.html b/actix_limitation/constant.DEFAULT_REQUEST_LIMIT.html
index 3a5f4eee4..fb72f4a8c 100644
--- a/actix_limitation/constant.DEFAULT_REQUEST_LIMIT.html
+++ b/actix_limitation/constant.DEFAULT_REQUEST_LIMIT.html
@@ -1,3 +1,3 @@
-DEFAULT_REQUEST_LIMIT in actix_limitation - Rust

+DEFAULT_REQUEST_LIMIT in actix_limitation - Rust

     
Constant actix_limitation::DEFAULT_REQUEST_LIMIT
source · 
pub const DEFAULT_REQUEST_LIMIT: usize = 5000;
Expand description
Default request limit.

 

\ No newline at end of file
diff --git a/actix_limitation/constant.DEFAULT_SESSION_KEY.html b/actix_limitation/constant.DEFAULT_SESSION_KEY.html
index 1470cd709..9a6beb006 100644
--- a/actix_limitation/constant.DEFAULT_SESSION_KEY.html
+++ b/actix_limitation/constant.DEFAULT_SESSION_KEY.html
@@ -1,3 +1,3 @@
-DEFAULT_SESSION_KEY in actix_limitation - Rust

+DEFAULT_SESSION_KEY in actix_limitation - Rust

     
Constant actix_limitation::DEFAULT_SESSION_KEY
source · 
pub const DEFAULT_SESSION_KEY: &str = "rate-api-id";
Expand description
Default session key.

 

\ No newline at end of file
diff --git a/actix_limitation/enum.Error.html b/actix_limitation/enum.Error.html
index e99273f9d..7a3e28270 100644
--- a/actix_limitation/enum.Error.html
+++ b/actix_limitation/enum.Error.html
@@ -1,4 +1,4 @@
-Error in actix_limitation - Rust

+Error in actix_limitation - Rust

     
Enum actix_limitation::Error
source · 
pub enum Error {
     Client(RedisError),
     LimitExceeded(Status),
@@ -9,7 +9,7 @@
 
§
LimitExceeded(Status)
Limit is exceeded for a key.

 
§
Time(ComponentRange)
Time conversion failed.

 
§
Other(String)
Generic error.

-
Trait Implementations§
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, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for Error
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<ComponentRange> for Error
source§
fn from(original: ComponentRange) -> Error
Converts to this type from the input type.
source§
impl From<RedisError> for Error
source§
fn from(original: RedisError) -> Error
Converts to this type from the input type.
Auto Trait Implementations§
§
impl !RefUnwindSafe for Error
§
impl Send for Error
§
impl Sync for Error
§
impl Unpin for Error
§
impl !UnwindSafe for Error
Blanket Implementations§
source§
impl<T> Any for T
where
+
Trait Implementations§
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, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for Error
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<ComponentRange> for Error
source§
fn from(original: ComponentRange) -> Error
Converts to this type from the input type.
source§
impl From<RedisError> for Error
source§
fn from(original: RedisError) -> Error
Converts to this type from the input type.
Auto Trait Implementations§
§
impl !RefUnwindSafe for Error
§
impl Send for Error
§
impl Sync for Error
§
impl Unpin for Error
§
impl !UnwindSafe for Error
Blanket Implementations§
source§
impl<T> Any for T
where
     T: 'static + ?Sized,
source§
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source§
impl<T> Borrow<T> for T
where
     T: ?Sized,
source§
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source§
impl<T> BorrowMut<T> for T
where
     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_limitation/index.html b/actix_limitation/index.html
index 3f7ce6597..9e2998d0b 100644
--- a/actix_limitation/index.html
+++ b/actix_limitation/index.html
@@ -1,4 +1,4 @@
-actix_limitation - Rust