diff --git a/actix_cors/all.html b/actix_cors/all.html index bab78cfb8..ee0b9ffec 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 a3b2020f4..d5821bfb6 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 b50376fc3..0d58ccc79 100644
--- a/actix_cors/index.html
+++ b/actix_cors/index.html
@@ -1,4 +1,4 @@
-actix_cors - Rust
Crate actix_cors
source · 
Expand description
Cross-Origin Resource Sharing (CORS) controls for Actix Web.

+actix_cors - Rust
Crate actix_cors
source · 
Expand description
Cross-Origin Resource Sharing (CORS) controls for Actix Web.

 
This middleware can be applied to both applications and resources. Once built, a Cors
 builder can be used as an argument for Actix Web’s App::wrap(), Scope::wrap(), or
 Resource::wrap() methods.

diff --git a/actix_cors/struct.Cors.html b/actix_cors/struct.Cors.html
index ffe3e1a2b..376a461cc 100644
--- a/actix_cors/struct.Cors.html
+++ b/actix_cors/struct.Cors.html
@@ -1,4 +1,4 @@
-Cors in actix_cors - Rust
Struct actix_cors::Cors
source · 
pub struct Cors { /* private fields */ }
Expand description
Builder for CORS middleware.

+Cors in actix_cors - Rust
Struct actix_cors::Cors
source · 
pub struct Cors { /* private fields */ }
Expand description
Builder for CORS middleware.

 
To construct a CORS middleware, call Cors::default() to create a blank, restrictive builder.
 Then use any of the builder methods to customize CORS behavior.

 
The alternative Cors::permissive() constructor is available for local development, allowing
diff --git a/actix_identity/all.html b/actix_identity/all.html
index 9627288fc..54ab55ea5 100644
--- a/actix_identity/all.html
+++ b/actix_identity/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_identity/config/enum.LogoutBehaviour.html b/actix_identity/config/enum.LogoutBehaviour.html
index a6709e60e..cced232e6 100644
--- a/actix_identity/config/enum.LogoutBehaviour.html
+++ b/actix_identity/config/enum.LogoutBehaviour.html
@@ -1,4 +1,4 @@
-LogoutBehaviour in actix_identity::config - Rust
Enum actix_identity::config::LogoutBehaviour
source · 
#[non_exhaustive]
pub enum LogoutBehaviour {
+LogoutBehaviour in actix_identity::config - Rust
Enum actix_identity::config::LogoutBehaviour
source · 
#[non_exhaustive]
pub enum LogoutBehaviour {
     PurgeSession,
     DeleteIdentityKeys,
 }
Expand description
LogoutBehaviour controls what actions are going to be performed when Identity::logout is
diff --git a/actix_identity/config/index.html b/actix_identity/config/index.html
index 14b73bbfc..a805317ce 100644
--- a/actix_identity/config/index.html
+++ b/actix_identity/config/index.html
@@ -1,4 +1,4 @@
-actix_identity::config - Rust
Module actix_identity::config
source · 
Expand description
Configuration options to tune the behaviour of IdentityMiddleware.

+actix_identity::config - Rust
Module actix_identity::config
source · 
Expand description
Configuration options to tune the behaviour of IdentityMiddleware.

 
Structs
Enums

\ No newline at end of file
diff --git a/actix_identity/config/struct.IdentityMiddlewareBuilder.html b/actix_identity/config/struct.IdentityMiddlewareBuilder.html
index 38d5e02c7..26de198b6 100644
--- a/actix_identity/config/struct.IdentityMiddlewareBuilder.html
+++ b/actix_identity/config/struct.IdentityMiddlewareBuilder.html
@@ -1,4 +1,4 @@
-IdentityMiddlewareBuilder in actix_identity::config - Rust
Struct actix_identity::config::IdentityMiddlewareBuilder
source · 
pub struct IdentityMiddlewareBuilder { /* private fields */ }
Expand description
A fluent builder to construct an IdentityMiddleware instance with custom configuration
+IdentityMiddlewareBuilder in actix_identity::config - Rust
Struct actix_identity::config::IdentityMiddlewareBuilder
source · 
pub struct IdentityMiddlewareBuilder { /* private fields */ }
Expand description
A fluent builder to construct an IdentityMiddleware instance with custom configuration
 parameters.

 
Use IdentityMiddleware::builder to get started!

 
Implementations§
source§
impl IdentityMiddlewareBuilder
source
pub fn logout_behaviour(self, logout_behaviour: LogoutBehaviour) -> Self
Determines how Identity::logout affects the current session.

diff --git a/actix_identity/error/enum.GetIdentityError.html b/actix_identity/error/enum.GetIdentityError.html
index 6cf419b15..524b6633e 100644
--- a/actix_identity/error/enum.GetIdentityError.html
+++ b/actix_identity/error/enum.GetIdentityError.html
@@ -1,4 +1,4 @@
-GetIdentityError in actix_identity::error - Rust
Enum actix_identity::error::GetIdentityError
source · 
#[non_exhaustive]
pub enum GetIdentityError {
+GetIdentityError in actix_identity::error - Rust
Enum actix_identity::error::GetIdentityError
source · 
#[non_exhaustive]
pub enum GetIdentityError {
     SessionExpiryError(SessionExpiryError),
     MissingIdentityError(MissingIdentityError),
     SessionGetError(SessionGetError),
@@ -9,7 +9,7 @@
 
§
SessionGetError(SessionGetError)
Failed to accessing the session store.

 
§
LostIdentityError(LostIdentityError)
Identity info was lost after being validated.

 
Seeing this error indicates a bug in actix-identity.

-
Trait Implementations§
source§
impl Debug for GetIdentityError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for GetIdentityError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for GetIdentityError
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<LostIdentityError> for GetIdentityError
source§
fn from(original: LostIdentityError) -> GetIdentityError
Converts to this type from the input type.
source§
impl From<MissingIdentityError> for GetIdentityError
source§
fn from(original: MissingIdentityError) -> GetIdentityError
Converts to this type from the input type.
source§
impl From<SessionExpiryError> for GetIdentityError
source§
fn from(original: SessionExpiryError) -> GetIdentityError
Converts to this type from the input type.
source§
impl From<SessionGetError> for GetIdentityError
source§
fn from(original: SessionGetError) -> GetIdentityError
Converts to this type from the input type.
source§
impl ResponseError for GetIdentityError
source§
fn status_code(&self) -> StatusCode
Returns appropriate status code for error. Read more
§
fn error_response(&self) -> HttpResponse<BoxBody>
Creates full response for error. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for Twhere
+
Trait Implementations§
source§
impl Debug for GetIdentityError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for GetIdentityError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for GetIdentityError
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<LostIdentityError> for GetIdentityError
source§
fn from(original: LostIdentityError) -> GetIdentityError
Converts to this type from the input type.
source§
impl From<MissingIdentityError> for GetIdentityError
source§
fn from(original: MissingIdentityError) -> GetIdentityError
Converts to this type from the input type.
source§
impl From<SessionExpiryError> for GetIdentityError
source§
fn from(original: SessionExpiryError) -> GetIdentityError
Converts to this type from the input type.
source§
impl From<SessionGetError> for GetIdentityError
source§
fn from(original: SessionGetError) -> GetIdentityError
Converts to this type from the input type.
source§
impl ResponseError for GetIdentityError
source§
fn status_code(&self) -> StatusCode
Returns appropriate status code for error. Read more
§
fn error_response(&self) -> HttpResponse<BoxBody>
Creates full response for error. Read more
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_identity/error/index.html b/actix_identity/error/index.html
index faf1051a0..cbc2eade5 100644
--- a/actix_identity/error/index.html
+++ b/actix_identity/error/index.html
@@ -1,2 +1,2 @@
-actix_identity::error - Rust
Module actix_identity::error
source · 
Expand description
Failure modes of identity operations.

+actix_identity::error - Rust
Module actix_identity::error
source · 
Expand description
Failure modes of identity operations.

 
Structs
Enums

\ No newline at end of file
diff --git a/actix_identity/error/struct.LoginError.html b/actix_identity/error/struct.LoginError.html
index 95eaa1eb9..88f3fbdcd 100644
--- a/actix_identity/error/struct.LoginError.html
+++ b/actix_identity/error/struct.LoginError.html
@@ -1,5 +1,5 @@
-LoginError in actix_identity::error - Rust
Struct actix_identity::error::LoginError
source · 
pub struct LoginError(/* private fields */);
Expand description
Error that can occur during login attempts.

-
Trait Implementations§
source§
impl Debug for LoginError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for LoginError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for LoginError
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<SessionInsertError> for LoginError
source§
fn from(original: SessionInsertError) -> LoginError
Converts to this type from the input type.
source§
impl ResponseError for LoginError
source§
fn status_code(&self) -> StatusCode
Returns appropriate status code for error. Read more
§
fn error_response(&self) -> HttpResponse<BoxBody>
Creates full response for error. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for Twhere
+LoginError in actix_identity::error - Rust
Struct actix_identity::error::LoginError
source · 
pub struct LoginError(/* private fields */);
Expand description
Error that can occur during login attempts.

+
Trait Implementations§
source§
impl Debug for LoginError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for LoginError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for LoginError
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<SessionInsertError> for LoginError
source§
fn from(original: SessionInsertError) -> LoginError
Converts to this type from the input type.
source§
impl ResponseError for LoginError
source§
fn status_code(&self) -> StatusCode
Returns appropriate status code for error. Read more
§
fn error_response(&self) -> HttpResponse<BoxBody>
Creates full response for error. Read more
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_identity/error/struct.LostIdentityError.html b/actix_identity/error/struct.LostIdentityError.html
index 632281b34..a492738c9 100644
--- a/actix_identity/error/struct.LostIdentityError.html
+++ b/actix_identity/error/struct.LostIdentityError.html
@@ -1,4 +1,4 @@
-LostIdentityError in actix_identity::error - Rust
Struct actix_identity::error::LostIdentityError
source · 
#[non_exhaustive]
pub struct LostIdentityError;
Expand description
The identity information has been lost.

+LostIdentityError in actix_identity::error - Rust
Struct actix_identity::error::LostIdentityError
source · 
#[non_exhaustive]
pub struct LostIdentityError;
Expand description
The identity information has been lost.

 
Seeing this error in user code indicates a bug in actix-identity.

 
Trait Implementations§
source§
impl Debug for LostIdentityError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for LostIdentityError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for LostIdentityError
1.30.0 · 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<LostIdentityError> for GetIdentityError
source§
fn from(original: LostIdentityError) -> GetIdentityError
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
diff --git a/actix_identity/error/struct.MissingIdentityError.html b/actix_identity/error/struct.MissingIdentityError.html
index 74a7810ef..d7b290997 100644
--- a/actix_identity/error/struct.MissingIdentityError.html
+++ b/actix_identity/error/struct.MissingIdentityError.html
@@ -1,4 +1,4 @@
-MissingIdentityError in actix_identity::error - Rust
Struct actix_identity::error::MissingIdentityError
source · 
#[non_exhaustive]
pub struct MissingIdentityError;
Expand description
There is no identity information attached to the current session.

+MissingIdentityError in actix_identity::error - Rust
Struct actix_identity::error::MissingIdentityError
source · 
#[non_exhaustive]
pub struct MissingIdentityError;
Expand description
There is no identity information attached to the current session.

 
Trait Implementations§
source§
impl Debug for MissingIdentityError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for MissingIdentityError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for MissingIdentityError
1.30.0 · 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<MissingIdentityError> for GetIdentityError
source§
fn from(original: MissingIdentityError) -> GetIdentityError
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
diff --git a/actix_identity/error/struct.SessionExpiryError.html b/actix_identity/error/struct.SessionExpiryError.html
index 830178da4..08c79e1db 100644
--- a/actix_identity/error/struct.SessionExpiryError.html
+++ b/actix_identity/error/struct.SessionExpiryError.html
@@ -1,5 +1,5 @@
-SessionExpiryError in actix_identity::error - Rust
Struct actix_identity::error::SessionExpiryError
source · 
pub struct SessionExpiryError(/* private fields */);
Expand description
Error encountered when working with a session that has expired.

-
Trait Implementations§
source§
impl Debug for SessionExpiryError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for SessionExpiryError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for SessionExpiryError
1.30.0 · 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<SessionExpiryError> for GetIdentityError
source§
fn from(original: SessionExpiryError) -> GetIdentityError
Converts to this type from the input type.
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for Twhere
+SessionExpiryError in actix_identity::error - Rust
Struct actix_identity::error::SessionExpiryError
source · 
pub struct SessionExpiryError(/* private fields */);
Expand description
Error encountered when working with a session that has expired.

+
Trait Implementations§
source§
impl Debug for SessionExpiryError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for SessionExpiryError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for SessionExpiryError
1.30.0 · 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<SessionExpiryError> for GetIdentityError
source§
fn from(original: SessionExpiryError) -> GetIdentityError
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_identity/index.html b/actix_identity/index.html
index b04e96549..a3d62a416 100644
--- a/actix_identity/index.html
+++ b/actix_identity/index.html
@@ -1,4 +1,4 @@
-actix_identity - Rust
Crate actix_identity
source · 
Expand description
Identity management for Actix Web.

+actix_identity - Rust
Crate actix_identity
source · 
Expand description
Identity management for Actix Web.

 
actix-identity can be used to track identity of a user across multiple requests. It is built
 on top of HTTP sessions, via actix-session.

 
Getting started

diff --git a/actix_identity/struct.Identity.html b/actix_identity/struct.Identity.html
index 87b833252..9df8fd159 100644
--- a/actix_identity/struct.Identity.html
+++ b/actix_identity/struct.Identity.html
@@ -1,4 +1,4 @@
-Identity in actix_identity - Rust
Struct actix_identity::Identity
source · 
pub struct Identity(/* private fields */);
Expand description
A verified user identity. It can be used as a request extractor.

+Identity in actix_identity - Rust
Struct actix_identity::Identity
source · 
pub struct Identity(/* private fields */);
Expand description
A verified user identity. It can be used as a request extractor.

 
The lifecycle of a user identity is tied to the lifecycle of the underlying session. If the
 session is destroyed (e.g. the session expired), the user identity will be forgotten, de-facto
 forcing a user log out.

diff --git a/actix_identity/struct.IdentityMiddleware.html b/actix_identity/struct.IdentityMiddleware.html
index b42717530..12aa88552 100644
--- a/actix_identity/struct.IdentityMiddleware.html
+++ b/actix_identity/struct.IdentityMiddleware.html
@@ -1,4 +1,4 @@
-IdentityMiddleware in actix_identity - Rust
Struct actix_identity::IdentityMiddleware
source · 
pub struct IdentityMiddleware { /* private fields */ }
Expand description
Identity management middleware.

+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};
 use actix_session::storage::RedisSessionStore;
diff --git a/actix_identity/trait.IdentityExt.html b/actix_identity/trait.IdentityExt.html
index 4d0b026fa..0a58458d8 100644
--- a/actix_identity/trait.IdentityExt.html
+++ b/actix_identity/trait.IdentityExt.html
@@ -1,6 +1,6 @@
-IdentityExt in actix_identity - Rust
Trait actix_identity::IdentityExt
source · 
pub trait IdentityExt {
+IdentityExt in actix_identity - Rust
Trait actix_identity::IdentityExt
source · 
pub trait IdentityExt {
     // Required method
     fn get_identity(&self) -> Result<Identity, GetIdentityError>;
 }
Expand description
Helper trait to retrieve an Identity instance from various actix-web’s types.

 
Required Methods§
source
fn get_identity(&self) -> Result<Identity, GetIdentityError>
Retrieve the identity attached to the current session, if available.

-
Implementations on Foreign Types§
source§
impl IdentityExt for ServiceRequest
source§
fn get_identity(&self) -> Result<Identity, GetIdentityError>
source§
impl IdentityExt for HttpRequest
source§
fn get_identity(&self) -> Result<Identity, GetIdentityError>
source§
impl<'a> IdentityExt for GuardContext<'a>
source§
fn get_identity(&self) -> Result<Identity, GetIdentityError>
Implementors§

\ No newline at end of file
+
Implementations on Foreign Types§
source§
impl IdentityExt for HttpRequest
source§
fn get_identity(&self) -> Result<Identity, GetIdentityError>
source§
impl<'a> IdentityExt for GuardContext<'a>
source§
fn get_identity(&self) -> Result<Identity, GetIdentityError>
source§
impl IdentityExt for ServiceRequest
source§
fn get_identity(&self) -> Result<Identity, GetIdentityError>
Implementors§

\ No newline at end of file
diff --git a/actix_limitation/all.html b/actix_limitation/all.html
index a8b1d6c28..cc6bcfd71 100644
--- a/actix_limitation/all.html
+++ b/actix_limitation/all.html
@@ -1 +1 @@
-List of all items in this crate
List of all items
Structs
Enums
Constants

\ No newline at end of file
+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 b1559311a..ac54dfe91 100644
--- a/actix_limitation/constant.DEFAULT_COOKIE_NAME.html
+++ b/actix_limitation/constant.DEFAULT_COOKIE_NAME.html
@@ -1,2 +1,2 @@
-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.

+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 8c50fd50a..7d182f341 100644
--- a/actix_limitation/constant.DEFAULT_PERIOD_SECS.html
+++ b/actix_limitation/constant.DEFAULT_PERIOD_SECS.html
@@ -1,2 +1,2 @@
-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).

+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 0baaddc05..9f6d431d8 100644
--- a/actix_limitation/constant.DEFAULT_REQUEST_LIMIT.html
+++ b/actix_limitation/constant.DEFAULT_REQUEST_LIMIT.html
@@ -1,2 +1,2 @@
-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.

+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 4381e4241..343cbeb77 100644
--- a/actix_limitation/constant.DEFAULT_SESSION_KEY.html
+++ b/actix_limitation/constant.DEFAULT_SESSION_KEY.html
@@ -1,2 +1,2 @@
-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.

+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 d1d530508..7eb9867f4 100644
--- a/actix_limitation/enum.Error.html
+++ b/actix_limitation/enum.Error.html
@@ -1,4 +1,4 @@
-Error in actix_limitation - Rust
Enum actix_limitation::Error
source · 
pub enum Error {
+Error in actix_limitation - Rust
Enum actix_limitation::Error
source · 
pub enum Error {
     Client(RedisError),
     LimitExceeded(Status),
     Time(ComponentRange),
@@ -8,7 +8,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 Twhere
+
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 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_limitation/index.html b/actix_limitation/index.html
index 9a3352de3..463468426 100644
--- a/actix_limitation/index.html
+++ b/actix_limitation/index.html
@@ -1,4 +1,4 @@
-actix_limitation - Rust
Crate actix_limitation
source · 
Expand description
Rate limiter using a fixed window counter for arbitrary keys, backed by Redis for Actix Web.

+actix_limitation - Rust
Crate actix_limitation
source · 
Expand description
Rate limiter using a fixed window counter for arbitrary keys, backed by Redis for Actix Web.

 
[dependencies]
 actix-web = "4"
 actix-limitation = "0.5"
diff --git a/actix_limitation/struct.Builder.html b/actix_limitation/struct.Builder.html
index f49d991f6..ff9567cc5 100644
--- a/actix_limitation/struct.Builder.html
+++ b/actix_limitation/struct.Builder.html
@@ -1,4 +1,4 @@
-Builder in actix_limitation - Rust
Struct actix_limitation::Builder
source · 
pub struct Builder { /* private fields */ }
Expand description
Rate limiter builder.

+Builder in actix_limitation - Rust
Struct actix_limitation::Builder
source · 
pub struct Builder { /* private fields */ }
Expand description
Rate limiter builder.

 
Implementations§
source§
impl Builder
source
pub fn limit(&mut self, limit: usize) -> &mut Self
Set upper limit.

 
source
pub fn period(&mut self, period: Duration) -> &mut Self
Set limit window/period.

 
source
pub fn key_by<F>(&mut self, resolver: F) -> &mut Selfwhere
diff --git a/actix_limitation/struct.Limiter.html b/actix_limitation/struct.Limiter.html
index e46d86080..ad345bfe5 100644
--- a/actix_limitation/struct.Limiter.html
+++ b/actix_limitation/struct.Limiter.html
@@ -1,4 +1,4 @@
-Limiter in actix_limitation - Rust
Struct actix_limitation::Limiter
source · 
pub struct Limiter { /* private fields */ }
Expand description
Rate limiter.

+Limiter in actix_limitation - Rust
Struct actix_limitation::Limiter
source · 
pub struct Limiter { /* private fields */ }
Expand description
Rate limiter.

 
Implementations§
source§
impl Limiter
source
pub fn builder(redis_url: impl Into<String>) -> Builder
Construct rate limiter builder with defaults.

 
See redis-rs docs on connection
 parameters for how to set the Redis URL.

diff --git a/actix_limitation/struct.RateLimiter.html b/actix_limitation/struct.RateLimiter.html
index b3ace2612..5c59596c3 100644
--- a/actix_limitation/struct.RateLimiter.html
+++ b/actix_limitation/struct.RateLimiter.html
@@ -1,4 +1,4 @@
-RateLimiter in actix_limitation - Rust
Struct actix_limitation::RateLimiter
source · 
#[non_exhaustive]
pub struct RateLimiter;
Expand description
Rate limit middleware.

+RateLimiter in actix_limitation - Rust
Struct actix_limitation::RateLimiter
source · 
#[non_exhaustive]
pub struct RateLimiter;
Expand description
Rate limit middleware.

 
Trait Implementations§
source§
impl Debug for RateLimiter
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Default for RateLimiter
source§
fn default() -> RateLimiter
Returns the “default value” for a type. Read more
source§
impl<S, B> Transform<S, ServiceRequest> for RateLimiterwhere
     S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
     S::Future: 'static,
diff --git a/actix_limitation/struct.Status.html b/actix_limitation/struct.Status.html
index e8d89da5e..7f153b24a 100644
--- a/actix_limitation/struct.Status.html
+++ b/actix_limitation/struct.Status.html
@@ -1,4 +1,4 @@
-Status in actix_limitation - Rust
Struct actix_limitation::Status
source · 
pub struct Status { /* private fields */ }
Expand description
A report for a given key containing the limit status.

+Status in actix_limitation - Rust
Struct actix_limitation::Status
source · 
pub struct Status { /* private fields */ }
Expand description
A report for a given key containing the limit status.

 
Implementations§
source§
impl Status
source
pub fn limit(&self) -> usize
Returns the maximum number of requests allowed in the current period.

 
source
pub fn remaining(&self) -> usize
Returns how many requests are left in the current period.

 
source
pub fn reset_epoch_utc(&self) -> usize
Returns a UNIX timestamp in UTC approximately when the next period will begin.

diff --git a/actix_protobuf/all.html b/actix_protobuf/all.html
index e74efbb3f..17eb2c7cf 100644
--- a/actix_protobuf/all.html
+++ b/actix_protobuf/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_protobuf/enum.ProtoBufPayloadError.html b/actix_protobuf/enum.ProtoBufPayloadError.html
index cda0cc17c..c29b8ebb4 100644
--- a/actix_protobuf/enum.ProtoBufPayloadError.html
+++ b/actix_protobuf/enum.ProtoBufPayloadError.html
@@ -1,4 +1,4 @@
-ProtoBufPayloadError in actix_protobuf - Rust
Enum actix_protobuf::ProtoBufPayloadError
source · 
pub enum ProtoBufPayloadError {
+ProtoBufPayloadError in actix_protobuf - Rust
Enum actix_protobuf::ProtoBufPayloadError
source · 
pub enum ProtoBufPayloadError {
     Overflow,
     ContentType,
     Serialize(EncodeError),
@@ -9,7 +9,7 @@
 
§
Serialize(EncodeError)
Serialize error

 
§
Deserialize(DecodeError)
Deserialize error

 
§
Payload(PayloadError)
Payload error

-
Trait Implementations§
source§
impl Debug for ProtoBufPayloadError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for ProtoBufPayloadError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl From<DecodeError> for ProtoBufPayloadError
source§
fn from(err: ProtoBufDecodeError) -> ProtoBufPayloadError
Converts to this type from the input type.
source§
impl From<PayloadError> for ProtoBufPayloadError
source§
fn from(err: PayloadError) -> ProtoBufPayloadError
Converts to this type from the input type.
source§
impl ResponseError for ProtoBufPayloadError
source§
fn error_response(&self) -> HttpResponse
Creates full response for error. Read more
§
fn status_code(&self) -> StatusCode
Returns appropriate status code for error. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for Twhere
+
Trait Implementations§
source§
impl Debug for ProtoBufPayloadError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for ProtoBufPayloadError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl From<DecodeError> for ProtoBufPayloadError
source§
fn from(err: ProtoBufDecodeError) -> ProtoBufPayloadError
Converts to this type from the input type.
source§
impl From<PayloadError> for ProtoBufPayloadError
source§
fn from(err: PayloadError) -> ProtoBufPayloadError
Converts to this type from the input type.
source§
impl ResponseError for ProtoBufPayloadError
source§
fn error_response(&self) -> HttpResponse
Creates full response for error. Read more
§
fn status_code(&self) -> StatusCode
Returns appropriate status code for error. Read more
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_protobuf/index.html b/actix_protobuf/index.html
index 11343b941..e3a4f78ad 100644
--- a/actix_protobuf/index.html
+++ b/actix_protobuf/index.html
@@ -1,2 +1,2 @@
-actix_protobuf - Rust
Crate actix_protobuf
source · 
Expand description
Protobuf payload extractor for Actix Web.

+actix_protobuf - Rust
Crate actix_protobuf
source · 
Expand description
Protobuf payload extractor for Actix Web.

 
Structs
Enums
Traits

\ No newline at end of file
diff --git a/actix_protobuf/struct.ProtoBuf.html b/actix_protobuf/struct.ProtoBuf.html
index e5e7ba622..c7f9ec2a4 100644
--- a/actix_protobuf/struct.ProtoBuf.html
+++ b/actix_protobuf/struct.ProtoBuf.html
@@ -1,4 +1,4 @@
-ProtoBuf in actix_protobuf - Rust
Struct actix_protobuf::ProtoBuf
source · 
pub struct ProtoBuf<T: Message>(pub T);
Tuple Fields§
§0: T
Trait Implementations§
source§
impl<T> Debug for ProtoBuf<T>where
+ProtoBuf in actix_protobuf - Rust
Struct actix_protobuf::ProtoBuf
source · 
pub struct ProtoBuf<T: Message>(pub T);
Tuple Fields§
§0: T
Trait Implementations§
source§
impl<T> Debug for ProtoBuf<T>where
     T: Debug + Message,
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl<T: Message> Deref for ProtoBuf<T>
§
type Target = T
The resulting type after dereferencing.
source§
fn deref(&self) -> &T
Dereferences the value.
source§
impl<T: Message> DerefMut for ProtoBuf<T>
source§
fn deref_mut(&mut self) -> &mut T
Mutably dereferences the value.
source§
impl<T> Display for ProtoBuf<T>where
     T: Display + Message,
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl<T> FromRequest for ProtoBuf<T>where
     T: Message + Default + 'static,
§
type Error = Error
The associated error which can be returned.
§
type Future = Pin<Box<dyn Future<Output = Result<ProtoBuf<T>, Error>>, Global>>
Future that resolves to a Self. Read more
source§
fn from_request(req: &HttpRequest, payload: &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
source§
impl<T: Message + Default> Responder for ProtoBuf<T>
§
type Body = BoxBody
source§
fn respond_to(self, _: &HttpRequest) -> HttpResponse
Convert self to HttpResponse.
§
fn customize(self) -> CustomizeResponder<Self>where
diff --git a/actix_protobuf/struct.ProtoBufConfig.html b/actix_protobuf/struct.ProtoBufConfig.html
index c1e6b9510..b6ea49ea7 100644
--- a/actix_protobuf/struct.ProtoBufConfig.html
+++ b/actix_protobuf/struct.ProtoBufConfig.html
@@ -1,4 +1,4 @@
-ProtoBufConfig in actix_protobuf - Rust
Struct actix_protobuf::ProtoBufConfig
source · 
pub struct ProtoBufConfig { /* private fields */ }
Implementations§
source§
impl ProtoBufConfig
source
pub fn limit(&mut self, limit: usize) -> &mut Self
Change max size of payload. By default max size is 256Kb

+ProtoBufConfig in actix_protobuf - Rust
Struct actix_protobuf::ProtoBufConfig
source · 
pub struct ProtoBufConfig { /* private fields */ }
Implementations§
source§
impl ProtoBufConfig
source
pub fn limit(&mut self, limit: usize) -> &mut Self
Change max size of payload. By default max size is 256Kb

 
Trait Implementations§
source§
impl Default for ProtoBufConfig
source§
fn default() -> Self
Returns the “default value” for a type. Read more
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
diff --git a/actix_protobuf/struct.ProtoBufMessage.html b/actix_protobuf/struct.ProtoBufMessage.html
index f8ed93fe4..15953da33 100644
--- a/actix_protobuf/struct.ProtoBufMessage.html
+++ b/actix_protobuf/struct.ProtoBufMessage.html
@@ -1,4 +1,4 @@
-ProtoBufMessage in actix_protobuf - Rust
Struct actix_protobuf::ProtoBufMessage
source · 
pub struct ProtoBufMessage<T: Message + Default> { /* private fields */ }
Implementations§
source§
impl<T: Message + Default> ProtoBufMessage<T>
source
pub fn new(req: &HttpRequest, payload: &mut Payload) -> Self
Create ProtoBufMessage for request.

+ProtoBufMessage in actix_protobuf - Rust
Struct actix_protobuf::ProtoBufMessage
source · 
pub struct ProtoBufMessage<T: Message + Default> { /* private fields */ }
Implementations§
source§
impl<T: Message + Default> ProtoBufMessage<T>
source
pub fn new(req: &HttpRequest, payload: &mut Payload) -> Self
Create ProtoBufMessage for request.

 
source
pub fn limit(self, limit: usize) -> Self
Change max size of payload. By default max size is 256Kb

 
Trait Implementations§
source§
impl<T: Message + Default + 'static> Future for ProtoBufMessage<T>
§
type Output = Result<T, ProtoBufPayloadError>
The type of value produced on completion.
source§
fn poll(self: Pin<&mut Self>, task: &mut Context<'_>) -> Poll<Self::Output>
Attempt to resolve the future to a final value, registering
 the current task for wakeup if the value is not yet available. Read more
Auto Trait Implementations§
§
impl<T> !RefUnwindSafe for ProtoBufMessage<T>
§
impl<T> !Send for ProtoBufMessage<T>
§
impl<T> !Sync for ProtoBufMessage<T>
§
impl<T> Unpin for ProtoBufMessage<T>
§
impl<T> !UnwindSafe for ProtoBufMessage<T>
Blanket Implementations§
source§
impl<T> Any for Twhere
diff --git a/actix_protobuf/trait.ProtoBufResponseBuilder.html b/actix_protobuf/trait.ProtoBufResponseBuilder.html
index 0f6a8e09c..c888bd47e 100644
--- a/actix_protobuf/trait.ProtoBufResponseBuilder.html
+++ b/actix_protobuf/trait.ProtoBufResponseBuilder.html
@@ -1,4 +1,4 @@
-ProtoBufResponseBuilder in actix_protobuf - Rust
Trait actix_protobuf::ProtoBufResponseBuilder
source · 
pub trait ProtoBufResponseBuilder {
+ProtoBufResponseBuilder in actix_protobuf - Rust
Trait actix_protobuf::ProtoBufResponseBuilder
source · 
pub trait ProtoBufResponseBuilder {
     // Required method
     fn protobuf<T: Message>(&mut self, value: T) -> Result<HttpResponse, Error>;
 }
Required Methods§
source
fn protobuf<T: Message>(&mut self, value: T) -> Result<HttpResponse, Error>
Implementations on Foreign Types§
source§
impl ProtoBufResponseBuilder for HttpResponseBuilder
source§
fn protobuf<T: Message>(&mut self, value: T) -> Result<HttpResponse, Error>
Implementors§

\ No newline at end of file
diff --git a/actix_redis/all.html b/actix_redis/all.html
index f7f27ec4d..32719d549 100644
--- a/actix_redis/all.html
+++ b/actix_redis/all.html
@@ -1 +1 @@
-List of all items in this crate
List of all items
Structs
Enums
Macros

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

\ No newline at end of file
diff --git a/actix_redis/enum.Error.html b/actix_redis/enum.Error.html
index 8cf51505c..ad1e82b3a 100644
--- a/actix_redis/enum.Error.html
+++ b/actix_redis/enum.Error.html
@@ -1,4 +1,4 @@
-Error in actix_redis - Rust
Enum actix_redis::Error
source · 
pub enum Error {
+Error in actix_redis - Rust
Enum actix_redis::Error
source · 
pub enum Error {
     Redis(Error),
     NotConnected,
     Disconnected,
diff --git a/actix_redis/enum.RespError.html b/actix_redis/enum.RespError.html
index 740660d39..22a9fd976 100644
--- a/actix_redis/enum.RespError.html
+++ b/actix_redis/enum.RespError.html
@@ -1,4 +1,4 @@
-RespError in actix_redis - Rust
Enum actix_redis::RespError
pub enum RespError {
+RespError in actix_redis - Rust
Enum actix_redis::RespError
pub enum RespError {
     Internal(String),
     IO(Arc<Error, Global>),
     Resp(String, Option<RespValue>),
@@ -16,8 +16,8 @@ chains of futures; but it occurring at runtime should be considered a catastroph
 failure.

 
If any error is propagated this way that needs to be handled, then it should be made into
 a proper option.

-
Trait Implementations§
§
impl Clone for Error
§
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
§
impl Debug for Error
§
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
§
impl Display for Error
§
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
§
impl Error for Error
§
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
§
impl From<Error> for Error
§
fn from(err: Error) -> Error
Converts to this type from the input type.
source§
impl From<Error> for Error
source§
fn from(original: Error) -> Error
Converts to this type from the input type.
§
impl<T> From<TrySendError<T>> for Errorwhere
-    T: 'static + Send,
§
fn from(err: TrySendError<T>) -> 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 Twhere
+
Trait Implementations§
§
impl Clone for Error
§
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
§
impl Debug for Error
§
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
§
impl Display for Error
§
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
§
impl Error for Error
§
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
§
impl From<Error> for Error
§
fn from(err: Error) -> Error
Converts to this type from the input type.
source§
impl From<Error> for Error
source§
fn from(original: Error) -> Error
Converts to this type from the input type.
§
impl<T> From<TrySendError<T>> for Errorwhere
+    T: 'static + Send,
§
fn from(err: TrySendError<T>) -> 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 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_redis/enum.RespValue.html b/actix_redis/enum.RespValue.html
index 6955bfaa3..5ca861e7c 100644
--- a/actix_redis/enum.RespValue.html
+++ b/actix_redis/enum.RespValue.html
@@ -1,4 +1,4 @@
-RespValue in actix_redis - Rust
Enum actix_redis::RespValue
pub enum RespValue {
+RespValue in actix_redis - Rust
Enum actix_redis::RespValue
pub enum RespValue {
     Nil,
     Array(Vec<RespValue, Global>),
     BulkString(Vec<u8, Global>),
@@ -21,7 +21,7 @@ arguments, e.g. RPUSH

 
pub fn push<T>(&mut self, item: T)where
     T: Into<RespValue>,
Push item to Resp array

 
This will panic if called for anything other than arrays

-
Trait Implementations§
§
impl Clone for RespValue
§
fn clone(&self) -> RespValue
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
§
impl Debug for RespValue
§
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
§
impl<'a> From<&'a [u8]> for RespValue
§
fn from(from: &'a [u8]) -> RespValue
Converts to this type from the input type.
§
impl<'a> From<&'a String> for RespValue
§
fn from(from: &'a String) -> RespValue
Converts to this type from the input type.
§
impl<'a> From<&'a str> for RespValue
§
fn from(from: &'a str) -> RespValue
Converts to this type from the input type.
§
impl<'a> From<Arc<str, Global>> for RespValue
§
fn from(from: Arc<str, Global>) -> RespValue
Converts to this type from the input type.
§
impl<'a> From<String> for RespValue
§
fn from(from: String) -> RespValue
Converts to this type from the input type.
§
impl<'a> From<Vec<u8, Global>> for RespValue
§
fn from(from: Vec<u8, Global>) -> RespValue
Converts to this type from the input type.
§
impl<'a> From<usize> for RespValue
§
fn from(from: usize) -> RespValue
Converts to this type from the input type.
§
impl FromResp for RespValue
§
fn from_resp_int(resp: RespValue) -> Result<RespValue, Error>
§
fn from_resp(resp: RespValue) -> Result<Self, Error>
Return a Result containing either Self or Error.  Errors can occur due to either: a) the particular
+
Trait Implementations§
§
impl Clone for RespValue
§
fn clone(&self) -> RespValue
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
§
impl Debug for RespValue
§
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
§
impl<'a> From<&'a [u8]> for RespValue
§
fn from(from: &'a [u8]) -> RespValue
Converts to this type from the input type.
§
impl<'a> From<&'a String> for RespValue
§
fn from(from: &'a String) -> RespValue
Converts to this type from the input type.
§
impl<'a> From<&'a str> for RespValue
§
fn from(from: &'a str) -> RespValue
Converts to this type from the input type.
§
impl<'a> From<Arc<str, Global>> for RespValue
§
fn from(from: Arc<str, Global>) -> RespValue
Converts to this type from the input type.
§
impl<'a> From<String> for RespValue
§
fn from(from: String) -> RespValue
Converts to this type from the input type.
§
impl<'a> From<Vec<u8, Global>> for RespValue
§
fn from(from: Vec<u8, Global>) -> RespValue
Converts to this type from the input type.
§
impl<'a> From<usize> for RespValue
§
fn from(from: usize) -> RespValue
Converts to this type from the input type.
§
impl FromResp for RespValue
§
fn from_resp_int(resp: RespValue) -> Result<RespValue, Error>
§
fn from_resp(resp: RespValue) -> Result<Self, Error>
Return a Result containing either Self or Error.  Errors can occur due to either: a) the particular
 RespValue being incompatible with the required type, or b) a remote Redis error occuring.
§
impl PartialEq<RespValue> for RespValue
§
fn eq(&self, other: &RespValue) -> 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.
§
impl Eq for RespValue
§
impl StructuralEq for RespValue
§
impl StructuralPartialEq for RespValue
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for Twhere
diff --git a/actix_redis/index.html b/actix_redis/index.html
index 7d2ead98f..e1baec18f 100644
--- a/actix_redis/index.html
+++ b/actix_redis/index.html
@@ -1,3 +1,3 @@
-actix_redis - Rust
Crate actix_redis
source · 
Expand description
Redis integration for actix.

+actix_redis - Rust
Crate actix_redis
source · 
Expand description
Redis integration for actix.

 
Macros
  • resp_array
    Macro to create a RESP array, useful for preparing commands to send.  Elements can be any type, or a mixture
 of types, that satisfy Into<RespValue>.
Structs
Enums
  • Error
    General purpose actix-redis error.
  • RespError
  • RespValue
    A single RESP value, this owns the data that is read/to-be written to Redis.

\ No newline at end of file
diff --git a/actix_redis/macro.resp_array.html b/actix_redis/macro.resp_array.html
index cb6577f6c..618f8f383 100644
--- a/actix_redis/macro.resp_array.html
+++ b/actix_redis/macro.resp_array.html
@@ -1,4 +1,4 @@
-resp_array in actix_redis - Rust
Macro actix_redis::resp_array
macro_rules! resp_array {
+resp_array in actix_redis - Rust
Macro actix_redis::resp_array
macro_rules! resp_array {
     ($($e:expr),* $(,)?) => { ... };
 }
Expand description
Macro to create a RESP array, useful for preparing commands to send.  Elements can be any type, or a mixture
 of types, that satisfy Into<RespValue>.

diff --git a/actix_redis/struct.Command.html b/actix_redis/struct.Command.html
index a33730c60..2b8d5a78e 100644
--- a/actix_redis/struct.Command.html
+++ b/actix_redis/struct.Command.html
@@ -1,5 +1,5 @@
-Command in actix_redis - Rust
Struct actix_redis::Command
source · 
pub struct Command(pub RespValue);
Expand description
Command for sending data to Redis.

-
Tuple Fields§
§0: RespValue
Trait Implementations§
source§
impl Debug for Command
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Handler<Command> for RedisActor
§
type Result = Pin<Box<dyn Future<Output = Result<RespValue, Error>>, Global>>
The type of value that this handler will return. Read more
source§
fn handle(&mut self, msg: Command, _: &mut Self::Context) -> Self::Result
This method is called for every message received by this actor.
source§
impl Message for Command
§
type Result = Result<RespValue, Error>
The type of value that this message will resolved with if it is
+Command in actix_redis - Rust
Struct actix_redis::Command
source · 
pub struct Command(pub RespValue);
Expand description
Command for sending data to Redis.

+
Tuple Fields§
§0: RespValue
Trait Implementations§
source§
impl Debug for Command
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Handler<Command> for RedisActor
§
type Result = Pin<Box<dyn Future<Output = Result<RespValue, Error>>, Global>>
The type of value that this handler will return. Read more
source§
fn handle(&mut self, msg: Command, _: &mut Self::Context) -> Self::Result
This method is called for every message received by this actor.
source§
impl Message for Command
§
type Result = Result<RespValue, Error>
The type of value that this message will resolved with if it is
 successful.
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
diff --git a/actix_redis/struct.RedisActor.html b/actix_redis/struct.RedisActor.html
index 6b03ee9b2..392ece067 100644
--- a/actix_redis/struct.RedisActor.html
+++ b/actix_redis/struct.RedisActor.html
@@ -1,11 +1,11 @@
-RedisActor in actix_redis - Rust
Struct actix_redis::RedisActor
source · 
pub struct RedisActor { /* private fields */ }
Expand description
Redis communication actor.

+RedisActor in actix_redis - Rust
Struct actix_redis::RedisActor
source · 
pub struct RedisActor { /* private fields */ }
Expand description
Redis communication actor.

 
Implementations§
source§
impl RedisActor
source
pub fn start<S: Into<String>>(addr: S) -> Addr<RedisActor>
Start new Supervisor with RedisActor.

 
Trait Implementations§
source§
impl Actor for RedisActor
§
type Context = Context<RedisActor>
Actor execution context type
source§
fn started(&mut self, ctx: &mut Context<Self>)
Called when an actor gets polled the first time.
§
fn stopping(&mut self, ctx: &mut Self::Context) -> Running
Called after an actor is in Actor::Stopping state. Read more
§
fn stopped(&mut self, ctx: &mut Self::Context)
Called after an actor is stopped. Read more
§
fn start(self) -> Addr<Self>where
     Self: Actor<Context = Context<Self>>,
Start a new asynchronous actor, returning its address. Read more
§
fn start_in_arbiter<F>(wrk: &ArbiterHandle, f: F) -> Addr<Self>where
     Self: Actor<Context = Context<Self>>,
     F: FnOnce(&mut Context<Self>) -> Self + Send + 'static,
Start new actor in arbiter’s thread.
§
fn create<F>(f: F) -> Addr<Self>where
     Self: Actor<Context = Context<Self>>,
-    F: FnOnce(&mut Context<Self>) -> Self,
Start a new asynchronous actor given a Context. Read more
source§
impl Handler<Command> for RedisActor
§
type Result = Pin<Box<dyn Future<Output = Result<RespValue, Error>>, Global>>
The type of value that this handler will return. Read more
source§
fn handle(&mut self, msg: Command, _: &mut Self::Context) -> Self::Result
This method is called for every message received by this actor.
source§
impl StreamHandler<Result<RespValue, Error>> for RedisActor
source§
fn handle(&mut self, msg: Result<RespValue, RespError>, ctx: &mut Self::Context)
Called for every message emitted by the stream.
§
fn started(&mut self, ctx: &mut Self::Context)
Called when stream emits first item. Read more
§
fn finished(&mut self, ctx: &mut Self::Context)
Called when stream finishes. Read more
§
fn add_stream<S>(stream: S, ctx: &mut Self::Context) -> SpawnHandlewhere
+    F: FnOnce(&mut Context<Self>) -> Self,
Start a new asynchronous actor given a Context. Read more
source§
impl Handler<Command> for RedisActor
§
type Result = Pin<Box<dyn Future<Output = Result<RespValue, Error>>, Global>>
The type of value that this handler will return. Read more
source§
fn handle(&mut self, msg: Command, _: &mut Self::Context) -> Self::Result
This method is called for every message received by this actor.
source§
impl StreamHandler<Result<RespValue, Error>> for RedisActor
source§
fn handle(&mut self, msg: Result<RespValue, RespError>, ctx: &mut Self::Context)
Called for every message emitted by the stream.
§
fn started(&mut self, ctx: &mut Self::Context)
Called when stream emits first item. Read more
§
fn finished(&mut self, ctx: &mut Self::Context)
Called when stream finishes. Read more
§
fn add_stream<S>(stream: S, ctx: &mut Self::Context) -> SpawnHandlewhere
     S: Stream + 'static,
     Self: StreamHandler<<S as Stream>::Item>,
     Self::Context: AsyncContext<Self>,
Register a Stream to the actor context.
source§
impl Supervised for RedisActor
source§
fn restarting(&mut self, _: &mut Self::Context)
Called when the supervisor restarts a failed actor.
source§
impl WriteHandler<Error> for RedisActor
source§
fn error(&mut self, err: Error, _: &mut Self::Context) -> Running
Called when the writer emits error. Read more
§
fn finished(&mut self, ctx: &mut Self::Context)
Called when the writer finishes. Read more
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for Twhere
diff --git a/actix_session/all.html b/actix_session/all.html
index 92cf25a4a..43e1d7d82 100644
--- a/actix_session/all.html
+++ b/actix_session/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_session/config/enum.CookieContentSecurity.html b/actix_session/config/enum.CookieContentSecurity.html
index 3ee7c0f6d..d82a4bc23 100644
--- a/actix_session/config/enum.CookieContentSecurity.html
+++ b/actix_session/config/enum.CookieContentSecurity.html
@@ -1,4 +1,4 @@
-CookieContentSecurity in actix_session::config - Rust
Enum actix_session::config::CookieContentSecurity
source · 
pub enum CookieContentSecurity {
+CookieContentSecurity in actix_session::config - Rust
Enum actix_session::config::CookieContentSecurity
source · 
pub enum CookieContentSecurity {
     Private,
     Signed,
 }
Expand description
Determines how to secure the content of the session cookie.

diff --git a/actix_session/config/enum.SessionLifecycle.html b/actix_session/config/enum.SessionLifecycle.html
index 6401ce1af..e3c7a0577 100644
--- a/actix_session/config/enum.SessionLifecycle.html
+++ b/actix_session/config/enum.SessionLifecycle.html
@@ -1,4 +1,4 @@
-SessionLifecycle in actix_session::config - Rust
Enum actix_session::config::SessionLifecycle
source · 
#[non_exhaustive]
pub enum SessionLifecycle {
+SessionLifecycle in actix_session::config - Rust
Enum actix_session::config::SessionLifecycle
source · 
#[non_exhaustive]
pub enum SessionLifecycle {
     BrowserSession(BrowserSession),
     PersistentSession(PersistentSession),
 }
Expand description
Determines what type of session cookie should be used and how its lifecycle should be managed.

@@ -11,7 +11,7 @@ Check the documentation of the browsers you are targeting for up-to-date informa
 
§
PersistentSession(PersistentSession)
The session cookie will be a persistent cookie.

 
Persistent cookies have a pre-determined lifetime, specified via the Max-Age or Expires
 attribute. They do not disappear when the current browser session ends.

-
Trait Implementations§
source§
impl Clone for SessionLifecycle
source§
fn clone(&self) -> SessionLifecycle
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 SessionLifecycle
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl From<BrowserSession> for SessionLifecycle
source§
fn from(original: BrowserSession) -> SessionLifecycle
Converts to this type from the input type.
source§
impl From<PersistentSession> for SessionLifecycle
source§
fn from(original: PersistentSession) -> SessionLifecycle
Converts to this type from the input type.
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for Twhere
+
Trait Implementations§
source§
impl Clone for SessionLifecycle
source§
fn clone(&self) -> SessionLifecycle
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 SessionLifecycle
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl From<BrowserSession> for SessionLifecycle
source§
fn from(original: BrowserSession) -> SessionLifecycle
Converts to this type from the input type.
source§
impl From<PersistentSession> for SessionLifecycle
source§
fn from(original: PersistentSession) -> SessionLifecycle
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_session/config/enum.TtlExtensionPolicy.html b/actix_session/config/enum.TtlExtensionPolicy.html
index 0a57f2898..7a3560cf3 100644
--- a/actix_session/config/enum.TtlExtensionPolicy.html
+++ b/actix_session/config/enum.TtlExtensionPolicy.html
@@ -1,4 +1,4 @@
-TtlExtensionPolicy in actix_session::config - Rust
Enum actix_session::config::TtlExtensionPolicy
source · 
#[non_exhaustive]
pub enum TtlExtensionPolicy {
+TtlExtensionPolicy in actix_session::config - Rust
Enum actix_session::config::TtlExtensionPolicy
source · 
#[non_exhaustive]
pub enum TtlExtensionPolicy {
     OnEveryRequest,
     OnStateChanges,
 }
Expand description
Configuration for which events should trigger an extension of the time-to-live for your session.

diff --git a/actix_session/config/index.html b/actix_session/config/index.html
index 2072f6580..05c518632 100644
--- a/actix_session/config/index.html
+++ b/actix_session/config/index.html
@@ -1,3 +1,3 @@
-actix_session::config - Rust
Module actix_session::config
source · 
Expand description
Configuration options to tune the behaviour of SessionMiddleware.

+actix_session::config - Rust
Module actix_session::config
source · 
Expand description
Configuration options to tune the behaviour of SessionMiddleware.

 
Structs
Enums
  • CookieContentSecurity
    Determines how to secure the content of the session cookie.
  • SessionLifecycle
    Determines what type of session cookie should be used and how its lifecycle should be managed.
  • TtlExtensionPolicy
    Configuration for which events should trigger an extension of the time-to-live for your session.

\ No newline at end of file
diff --git a/actix_session/config/struct.BrowserSession.html b/actix_session/config/struct.BrowserSession.html
index dfd3c82f3..386ad9061 100644
--- a/actix_session/config/struct.BrowserSession.html
+++ b/actix_session/config/struct.BrowserSession.html
@@ -1,4 +1,4 @@
-BrowserSession in actix_session::config - Rust
Struct actix_session::config::BrowserSession
source · 
pub struct BrowserSession { /* private fields */ }
Expand description
A session lifecycle strategy where the session cookie expires when the
+BrowserSession in actix_session::config - Rust
Struct actix_session::config::BrowserSession
source · 
pub struct BrowserSession { /* private fields */ }
Expand description
A session lifecycle strategy where the session cookie expires when the
 browser’s current session ends.

 
When does a browser session end? It depends on the browser. Chrome, for example, will often
 continue running in the background when the browser is closed—session cookies are not deleted
diff --git a/actix_session/config/struct.PersistentSession.html b/actix_session/config/struct.PersistentSession.html
index 3da62d89f..dd851fc43 100644
--- a/actix_session/config/struct.PersistentSession.html
+++ b/actix_session/config/struct.PersistentSession.html
@@ -1,4 +1,4 @@
-PersistentSession in actix_session::config - Rust
Struct actix_session::config::PersistentSession
source · 
pub struct PersistentSession { /* private fields */ }
Expand description
A session lifecycle strategy where the session cookie will be persistent.

+PersistentSession in actix_session::config - Rust
Struct actix_session::config::PersistentSession
source · 
pub struct PersistentSession { /* private fields */ }
Expand description
A session lifecycle strategy where the session cookie will be persistent.

 
Persistent cookies have a pre-determined expiration, specified via the Max-Age or Expires
 attribute. They do not disappear when the current browser session ends.

 
Due to its Into<SessionLifecycle> implementation, a PersistentSession can be passed directly
diff --git a/actix_session/config/struct.SessionMiddlewareBuilder.html b/actix_session/config/struct.SessionMiddlewareBuilder.html
index 6ee3e4279..0cf9864a0 100644
--- a/actix_session/config/struct.SessionMiddlewareBuilder.html
+++ b/actix_session/config/struct.SessionMiddlewareBuilder.html
@@ -1,4 +1,4 @@
-SessionMiddlewareBuilder in actix_session::config - Rust
Struct actix_session::config::SessionMiddlewareBuilder
source · 
pub struct SessionMiddlewareBuilder<Store: SessionStore> { /* private fields */ }
Expand description
A fluent, customized SessionMiddleware builder.

+SessionMiddlewareBuilder in actix_session::config - Rust
Struct actix_session::config::SessionMiddlewareBuilder
source · 
pub struct SessionMiddlewareBuilder<Store: SessionStore> { /* private fields */ }
Expand description
A fluent, customized SessionMiddleware builder.

 
Implementations§
source§
impl<Store: SessionStore> SessionMiddlewareBuilder<Store>
source
pub fn cookie_name(self, name: String) -> Self
Set the name of the cookie used to store the session ID.

 
Defaults to id.

 
source
pub fn cookie_secure(self, secure: bool) -> Self
Set the Secure attribute for the cookie used to store the session ID.

diff --git a/actix_session/enum.SessionStatus.html b/actix_session/enum.SessionStatus.html
index 42970aa40..c677a277b 100644
--- a/actix_session/enum.SessionStatus.html
+++ b/actix_session/enum.SessionStatus.html
@@ -1,4 +1,4 @@
-SessionStatus in actix_session - Rust
Enum actix_session::SessionStatus
source · 
pub enum SessionStatus {
+SessionStatus in actix_session - Rust
Enum actix_session::SessionStatus
source · 
pub enum SessionStatus {
     Changed,
     Purged,
     Renewed,
diff --git a/actix_session/index.html b/actix_session/index.html
index e1dcb4307..c1b2112b8 100644
--- a/actix_session/index.html
+++ b/actix_session/index.html
@@ -1,4 +1,4 @@
-actix_session - Rust
Crate actix_session
source · 
Expand description
Session management for Actix Web.

+actix_session - Rust
Crate actix_session
source · 
Expand description
Session management for Actix Web.

 
The HTTP protocol, at a first glance, is stateless: the client sends a request, the server
 parses its content, performs some processing and returns a response. The outcome is only
 influenced by the provided inputs (i.e. the request content) and whatever state the server
diff --git a/actix_session/storage/enum.LoadError.html b/actix_session/storage/enum.LoadError.html
index 858b2870c..d782b490c 100644
--- a/actix_session/storage/enum.LoadError.html
+++ b/actix_session/storage/enum.LoadError.html
@@ -1,10 +1,10 @@
-LoadError in actix_session::storage - Rust
Enum actix_session::storage::LoadError
source · 
pub enum LoadError {
+LoadError in actix_session::storage - Rust
Enum actix_session::storage::LoadError
source · 
pub enum LoadError {
     Deserialization(Error),
     Other(Error),
 }
Expand description
Possible failures modes for SessionStore::load.

 
Variants§
§
Deserialization(Error)
Failed to deserialize session state.

 
§
Other(Error)
Something went wrong when retrieving the session state.

-
Trait Implementations§
source§
impl Debug for LoadError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for LoadError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for LoadError
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
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for Twhere
+
Trait Implementations§
source§
impl Debug for LoadError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for LoadError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for LoadError
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
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_session/storage/enum.SaveError.html b/actix_session/storage/enum.SaveError.html
index c28bafe2e..75f6af412 100644
--- a/actix_session/storage/enum.SaveError.html
+++ b/actix_session/storage/enum.SaveError.html
@@ -1,10 +1,10 @@
-SaveError in actix_session::storage - Rust
Enum actix_session::storage::SaveError
source · 
pub enum SaveError {
+SaveError in actix_session::storage - Rust
Enum actix_session::storage::SaveError
source · 
pub enum SaveError {
     Serialization(Error),
     Other(Error),
 }
Expand description
Possible failures modes for SessionStore::save.

 
Variants§
§
Serialization(Error)
Failed to serialize session state.

 
§
Other(Error)
Something went wrong when persisting the session state.

-
Trait Implementations§
source§
impl Debug for SaveError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for SaveError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for SaveError
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
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for Twhere
+
Trait Implementations§
source§
impl Debug for SaveError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for SaveError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for SaveError
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
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_session/storage/enum.UpdateError.html b/actix_session/storage/enum.UpdateError.html
index e74765100..e128f91e2 100644
--- a/actix_session/storage/enum.UpdateError.html
+++ b/actix_session/storage/enum.UpdateError.html
@@ -1,10 +1,10 @@
-UpdateError in actix_session::storage - Rust
Enum actix_session::storage::UpdateError
source · 
pub enum UpdateError {
+UpdateError in actix_session::storage - Rust
Enum actix_session::storage::UpdateError
source · 
pub enum UpdateError {
     Serialization(Error),
     Other(Error),
 }
Expand description
Possible failures modes for SessionStore::update.

 
Variants§
§
Serialization(Error)
Failed to serialize session state.

 
§
Other(Error)
Something went wrong when updating the session state.

-
Trait Implementations§
source§
impl Debug for UpdateError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for UpdateError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for UpdateError
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
Auto Trait Implementations§
Blanket Implementations§
source§
impl<T> Any for Twhere
+
Trait Implementations§
source§
impl Debug for UpdateError
source§
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Display for UpdateError
source§
fn fmt(&self, _derive_more_display_formatter: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source§
impl Error for UpdateError
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
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_session/storage/index.html b/actix_session/storage/index.html
index 7a9526fda..2f8db0b59 100644
--- a/actix_session/storage/index.html
+++ b/actix_session/storage/index.html
@@ -1,4 +1,4 @@
-actix_session::storage - Rust
Module actix_session::storage
source · 
Expand description
Pluggable storage backends for session state.

+actix_session::storage - Rust
Module actix_session::storage
source · 
Expand description
Pluggable storage backends for session state.

 
Structs