List of all items
Structs
- Identity
- IdentityMiddleware
- config::IdentityMiddlewareBuilder
- error::LoginError
- error::LostIdentityError
- error::MissingIdentityError
- error::SessionExpiryError
#[non_exhaustive]pub enum LogoutBehaviour {
PurgeSession,
DeleteIdentityKeys,
diff --git a/actix_identity/config/index.html b/actix_identity/config/index.html
index a2e36cfb0..8ad1e22ff 100644
--- a/actix_identity/config/index.html
+++ b/actix_identity/config/index.html
@@ -1,4 +1,4 @@
-actix_identity::config - Rust
+actix_identity::config - Rust
Module actix_identity::config
source · Expand description
Configuration options to tune the behaviour of IdentityMiddleware.
Structs
- A fluent builder to construct an
IdentityMiddleware instance with custom configuration
parameters.
Enums
LogoutBehaviour controls what actions are going to be performed when Identity::logout is
diff --git a/actix_identity/config/struct.IdentityMiddlewareBuilder.html b/actix_identity/config/struct.IdentityMiddlewareBuilder.html
index 5ebf81baf..ec2053cf7 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
+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!
diff --git a/actix_identity/error/enum.GetIdentityError.html b/actix_identity/error/enum.GetIdentityError.html
index 82200a644..7e277cbd0 100644
--- a/actix_identity/error/enum.GetIdentityError.html
+++ b/actix_identity/error/enum.GetIdentityError.html
@@ -1,16 +1,16 @@
-GetIdentityError in actix_identity::error - Rust
+GetIdentityError in actix_identity::error - Rust
Enum actix_identity::error::GetIdentityError
source · #[non_exhaustive]pub enum GetIdentityError {
SessionExpiryError(SessionExpiryError),
MissingIdentityError(MissingIdentityError),
- SessionGetError(SessionGetError),
+ SessionGetError(SessionGetError),
LostIdentityError(LostIdentityError),
}
Expand description
Errors that can occur while retrieving an identity.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.§SessionExpiryError(SessionExpiryError)
The session has expired.
§MissingIdentityError(MissingIdentityError)
No identity is found in a session.
-§SessionGetError(SessionGetError)
Failed to accessing the session store.
+§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§impl Display for GetIdentityError
source§impl Error for GetIdentityError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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
Creates full response for error. Read moreAuto Trait Implementations§
§impl RefUnwindSafe for GetIdentityError
§impl Send for GetIdentityError
§impl Sync for GetIdentityError
§impl Unpin for GetIdentityError
§impl UnwindSafe for GetIdentityError
Blanket Implementations§
Trait Implementations§
source§impl Debug for GetIdentityError
source§impl Display for GetIdentityError
source§impl Error for GetIdentityError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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
Creates full response for error. Read moreAuto Trait Implementations§
§impl RefUnwindSafe for GetIdentityError
§impl Send for GetIdentityError
§impl Sync for GetIdentityError
§impl Unpin for GetIdentityError
§impl UnwindSafe for GetIdentityError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§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 35c657c6a..3251e2af0 100644
--- a/actix_identity/error/index.html
+++ b/actix_identity/error/index.html
@@ -1,3 +1,3 @@
-actix_identity::error - Rust
+actix_identity::error - Rust
Module actix_identity::error
source · Expand description
Failure modes of identity operations.
Structs
- Error that can occur during login attempts.
- The identity information has been lost.
- There is no identity information attached to the current session.
- Error encountered when working with a session that has expired.
Enums
- Errors that can occur while retrieving an identity.
LoginError in actix_identity::error - Rust
+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§impl Display for LoginError
source§impl Error for LoginError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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
Creates full response for error. Read moreAuto Trait Implementations§
§impl RefUnwindSafe for LoginError
§impl Send for LoginError
§impl Sync for LoginError
§impl Unpin for LoginError
§impl UnwindSafe for LoginError
Blanket Implementations§
Trait Implementations§
source§impl Debug for LoginError
source§impl Display for LoginError
source§impl Error for LoginError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()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
Creates full response for error. Read moreAuto Trait Implementations§
§impl RefUnwindSafe for LoginError
§impl Send for LoginError
§impl Sync for LoginError
§impl Unpin for LoginError
§impl UnwindSafe for LoginError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§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 7300dcf89..a980dacea 100644
--- a/actix_identity/error/struct.LostIdentityError.html
+++ b/actix_identity/error/struct.LostIdentityError.html
@@ -1,7 +1,7 @@
-LostIdentityError in actix_identity::error - Rust
+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§impl Display for LostIdentityError
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 more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<LostIdentityError> for GetIdentityError
source§fn from(original: LostIdentityError) -> GetIdentityError
Converts to this type from the input type.Auto Trait Implementations§
§impl RefUnwindSafe for LostIdentityError
§impl Send for LostIdentityError
§impl Sync for LostIdentityError
§impl Unpin for LostIdentityError
§impl UnwindSafe for LostIdentityError
Blanket Implementations§
Trait Implementations§
source§impl Debug for LostIdentityError
source§impl Display for LostIdentityError
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 more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<LostIdentityError> for GetIdentityError
source§fn from(original: LostIdentityError) -> GetIdentityError
Converts to this type from the input type.Auto Trait Implementations§
§impl RefUnwindSafe for LostIdentityError
§impl Send for LostIdentityError
§impl Sync for LostIdentityError
§impl Unpin for LostIdentityError
§impl UnwindSafe for LostIdentityError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/actix_identity/error/struct.MissingIdentityError.html b/actix_identity/error/struct.MissingIdentityError.html
index 199300e54..19b404200 100644
--- a/actix_identity/error/struct.MissingIdentityError.html
+++ b/actix_identity/error/struct.MissingIdentityError.html
@@ -1,6 +1,6 @@
-MissingIdentityError in actix_identity::error - Rust
+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§impl Display for MissingIdentityError
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 more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<MissingIdentityError> for GetIdentityError
source§fn from(original: MissingIdentityError) -> GetIdentityError
Converts to this type from the input type.Auto Trait Implementations§
§impl RefUnwindSafe for MissingIdentityError
§impl Send for MissingIdentityError
§impl Sync for MissingIdentityError
§impl Unpin for MissingIdentityError
§impl UnwindSafe for MissingIdentityError
Blanket Implementations§
Trait Implementations§
source§impl Debug for MissingIdentityError
source§impl Display for MissingIdentityError
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 more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<MissingIdentityError> for GetIdentityError
source§fn from(original: MissingIdentityError) -> GetIdentityError
Converts to this type from the input type.Auto Trait Implementations§
§impl RefUnwindSafe for MissingIdentityError
§impl Send for MissingIdentityError
§impl Sync for MissingIdentityError
§impl Unpin for MissingIdentityError
§impl UnwindSafe for MissingIdentityError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/actix_identity/error/struct.SessionExpiryError.html b/actix_identity/error/struct.SessionExpiryError.html
index dd1ff2c6c..096e4a4eb 100644
--- a/actix_identity/error/struct.SessionExpiryError.html
+++ b/actix_identity/error/struct.SessionExpiryError.html
@@ -1,4 +1,4 @@
-SessionExpiryError in actix_identity::error - Rust
+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§impl Display for SessionExpiryError
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 more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<SessionExpiryError> for GetIdentityError
source§fn from(original: SessionExpiryError) -> GetIdentityError
Converts to this type from the input type.Auto Trait Implementations§
§impl RefUnwindSafe for SessionExpiryError
§impl Send for SessionExpiryError
§impl Sync for SessionExpiryError
§impl Unpin for SessionExpiryError
§impl UnwindSafe for SessionExpiryError
Blanket Implementations§