#[non_exhaustive]
+CorsError in actix_cors - Rust Enum actix_cors::CorsError
source · #[non_exhaustive]
pub enum CorsError {
WildcardOrigin,
MissingOrigin,
@@ -17,7 +17,7 @@ pub enum CorsError {
§OriginNotAllowed
Origin is not allowed to make this request.
§MethodNotAllowed
Request method is not allowed.
§HeadersNotAllowed
One or more request headers are not allowed.
-Subscriber to this type, returning a
diff --git a/actix_cors/index.html b/actix_cors/index.html
index 5243b36c0..3cc7b0457 100644
--- a/actix_cors/index.html
+++ b/actix_cors/index.html
@@ -1,4 +1,4 @@
-Cross-Origin Resource Sharing (CORS) controls for Actix Web.
+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.
pub struct Cors { /* private fields */ }Builder for CORS middleware.
+pub struct Cors { /* private fields */ }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
@@ -143,8 +143,8 @@ not supported. No max age (will use browser’s default).
That is, this conversion is whatever the implementation of
From<T> for U chooses to do.
Subscriber to this type, returning a
diff --git a/actix_identity/all.html b/actix_identity/all.html
index bbdb89641..b930730ea 100644
--- a/actix_identity/all.html
+++ b/actix_identity/all.html
@@ -1 +1 @@
-#[non_exhaustive]
+LogoutBehaviour in actix_identity::config - Rust Enum actix_identity::config::LogoutBehaviour
source · #[non_exhaustive]
pub enum LogoutBehaviour {
PurgeSession,
DeleteIdentityKeys,
@@ -23,8 +23,8 @@ is not tied to the user’s identity and should be retained after logout.
From<T> for U chooses to do.
Subscriber to this type, returning a
diff --git a/actix_identity/config/index.html b/actix_identity/config/index.html
index a96a194ad..4a9b0a9a8 100644
--- a/actix_identity/config/index.html
+++ b/actix_identity/config/index.html
@@ -1,4 +1,4 @@
-Configuration options to tune the behaviour of IdentityMiddleware.
Configuration options to tune the behaviour of IdentityMiddleware.
IdentityMiddleware instance with custom configuration
parameters.LogoutBehaviour controls what actions are going to be performed when Identity::logout is
invoked.pub struct IdentityMiddlewareBuilder { /* private fields */ }A fluent builder to construct an IdentityMiddleware instance with custom configuration
+
pub struct IdentityMiddlewareBuilder { /* private fields */ }A fluent builder to construct an IdentityMiddleware instance with custom configuration
parameters.
Use IdentityMiddleware::builder to get started!
Determines how Identity::logout affects the current session.
From<T> for U chooses to do.
Subscriber to this type, returning a
diff --git a/actix_identity/error/enum.GetIdentityError.html b/actix_identity/error/enum.GetIdentityError.html
index 046ed82aa..f34bf0a0f 100644
--- a/actix_identity/error/enum.GetIdentityError.html
+++ b/actix_identity/error/enum.GetIdentityError.html
@@ -1,4 +1,4 @@
-#[non_exhaustive]
+GetIdentityError in actix_identity::error - Rust Enum actix_identity::error::GetIdentityError
source · #[non_exhaustive]
pub enum GetIdentityError {
SessionExpiryError(SessionExpiryError),
MissingIdentityError(MissingIdentityError),
@@ -10,7 +10,7 @@ pub enum GetIdentityError {
§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.
-Returns the argument unchanged.
@@ -24,8 +24,8 @@ pub enum GetIdentityError { E: Error + ?Sized,Subscriber to this type, returning a
diff --git a/actix_identity/error/index.html b/actix_identity/error/index.html
index 25c7c0e6b..7755d14f0 100644
--- a/actix_identity/error/index.html
+++ b/actix_identity/error/index.html
@@ -1,2 +1,2 @@
-Failure modes of identity operations.
+Failure modes of identity operations.
pub struct LoginError(_);Error that can occur during login attempts.
-pub struct LoginError(_);Error that can occur during login attempts.
+Returns the argument unchanged.
@@ -13,8 +13,8 @@ E: Error + ?Sized,Subscriber to this type, returning a
diff --git a/actix_identity/error/struct.LostIdentityError.html b/actix_identity/error/struct.LostIdentityError.html
index fc6a77796..8baa5d88c 100644
--- a/actix_identity/error/struct.LostIdentityError.html
+++ b/actix_identity/error/struct.LostIdentityError.html
@@ -1,4 +1,4 @@
-#[non_exhaustive]pub struct LostIdentityError;The identity information has been lost.
+#[non_exhaustive]pub struct LostIdentityError;The identity information has been lost.
Seeing this error in user code indicates a bug in actix-identity.
Subscriber to this type, returning a
diff --git a/actix_identity/error/struct.MissingIdentityError.html b/actix_identity/error/struct.MissingIdentityError.html
index 83ff7ed95..1ece40bed 100644
--- a/actix_identity/error/struct.MissingIdentityError.html
+++ b/actix_identity/error/struct.MissingIdentityError.html
@@ -1,5 +1,5 @@
-#[non_exhaustive]pub struct MissingIdentityError;There is no identity information attached to the current session.
-#[non_exhaustive]pub struct MissingIdentityError;There is no identity information attached to the current session.
+Returns the argument unchanged.
@@ -13,8 +13,8 @@ E: Error + ?Sized,Subscriber to this type, returning a
diff --git a/actix_identity/error/struct.SessionExpiryError.html b/actix_identity/error/struct.SessionExpiryError.html
index 7c4aac072..22b9229ce 100644
--- a/actix_identity/error/struct.SessionExpiryError.html
+++ b/actix_identity/error/struct.SessionExpiryError.html
@@ -1,5 +1,5 @@
-pub struct SessionExpiryError(_);Error encountered when working with a session that has expired.
-pub struct SessionExpiryError(_);Error encountered when working with a session that has expired.
+Returns the argument unchanged.
@@ -13,8 +13,8 @@ E: Error + ?Sized,Subscriber to this type, returning a
diff --git a/actix_identity/index.html b/actix_identity/index.html
index 82926a80f..a9782e744 100644
--- a/actix_identity/index.html
+++ b/actix_identity/index.html
@@ -1,4 +1,4 @@
-Identity management for Actix Web.
+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.
pub struct Identity(_);A verified user identity. It can be used as a request extractor.
+pub struct Identity(_);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.
@@ -112,8 +112,8 @@ require a valid From<T> for U chooses to do.Subscriber to this type, returning a
diff --git a/actix_identity/struct.IdentityMiddleware.html b/actix_identity/struct.IdentityMiddleware.html
index 184b8d2de..c06fd0424 100644
--- a/actix_identity/struct.IdentityMiddleware.html
+++ b/actix_identity/struct.IdentityMiddleware.html
@@ -1,4 +1,4 @@
-pub struct IdentityMiddleware { /* private fields */ }Identity management middleware.
+pub struct IdentityMiddleware { /* private fields */ }Identity management middleware.
use actix_web::{cookie::Key, App, HttpServer};
use actix_session::storage::RedisSessionStore;
@@ -35,8 +35,8 @@
From<T> for U chooses to do.
Subscriber to this type, returning a
diff --git a/actix_identity/trait.IdentityExt.html b/actix_identity/trait.IdentityExt.html
index 6497a357a..6af393de1 100644
--- a/actix_identity/trait.IdentityExt.html
+++ b/actix_identity/trait.IdentityExt.html
@@ -1,6 +1,6 @@
-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§
sourcefn 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<'a> IdentityExt for GuardContext<'a>
source§fn get_identity(&self) -> Result<Identity, GetIdentityError>
source§impl IdentityExt for HttpRequest
source§fn get_identity(&self) -> Result<Identity, GetIdentityError>
Implementors§
pub const DEFAULT_COOKIE_NAME: &str = "sid";Default cookie name.
+pub const DEFAULT_COOKIE_NAME: &str = "sid";Default cookie name.
pub const DEFAULT_PERIOD_SECS: u64 = 3600;Default period (in seconds).
+pub const DEFAULT_PERIOD_SECS: u64 = 3600;Default period (in seconds).
pub const DEFAULT_REQUEST_LIMIT: usize = 5000;Default request limit.
+pub const DEFAULT_REQUEST_LIMIT: usize = 5000;Default request limit.
pub const DEFAULT_SESSION_KEY: &str = "rate-api-id";Default session key.
+pub const DEFAULT_SESSION_KEY: &str = "rate-api-id";Default session key.
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.
-Returns the argument unchanged.
@@ -22,8 +22,8 @@ E: Error + ?Sized,Subscriber to this type, returning a
diff --git a/actix_limitation/index.html b/actix_limitation/index.html
index 6e7912062..8ef7b9a2f 100644
--- a/actix_limitation/index.html
+++ b/actix_limitation/index.html
@@ -1,4 +1,4 @@
-Rate limiter using a fixed window counter for arbitrary keys, backed by Redis for Actix Web.
+Rate limiter using a fixed window counter for arbitrary keys, backed by Redis for Actix Web.
[dependencies]
actix-web = "4"
actix-limitation = "0.4"
diff --git a/actix_limitation/struct.Builder.html b/actix_limitation/struct.Builder.html
index ad268c43c..3473f3a43 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<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
diff --git a/actix_limitation/struct.Limiter.html b/actix_limitation/struct.Limiter.html
index 4a7a53bd9..5024ce5cc 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<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
diff --git a/actix_limitation/struct.RateLimiter.html b/actix_limitation/struct.RateLimiter.html
index ed4659d34..7e394f210 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§impl Default for RateLimiter
source§fn default() -> RateLimiter
Returns the “default value” for a type. Read moresource§impl<S, B> Transform<S, ServiceRequest> for RateLimiterwhere
S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
S::Future: 'static,
@@ -13,8 +13,8 @@
That is, this conversion is whatever the implementation of
From<T> for U chooses to do.
source§impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
diff --git a/actix_limitation/struct.Status.html b/actix_limitation/struct.Status.html
index 722162b08..5a9557ea6 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