#[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 b43969286..464c1214e 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 f56f9eca3..6f619cb24 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 a7004cee1..cedf3dea5 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 fea1245e5..ac1a82fb1 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 e4eb14421..2c647dac2 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.
Subscriber to this type, returning a
diff --git a/actix_identity/error/struct.LostIdentityError.html b/actix_identity/error/struct.LostIdentityError.html
index b13a031ea..e1d618446 100644
--- a/actix_identity/error/struct.LostIdentityError.html
+++ b/actix_identity/error/struct.LostIdentityError.html
@@ -1,6 +1,6 @@
-#[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.
-Returns the argument unchanged.
@@ -14,8 +14,8 @@ E: Error + ?Sized,Subscriber to this type, returning a
diff --git a/actix_identity/error/struct.MissingIdentityError.html b/actix_identity/error/struct.MissingIdentityError.html
index 6907298f8..608201ef4 100644
--- a/actix_identity/error/struct.MissingIdentityError.html
+++ b/actix_identity/error/struct.MissingIdentityError.html
@@ -1,4 +1,4 @@
-#[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.
Subscriber to this type, returning a
diff --git a/actix_identity/error/struct.SessionExpiryError.html b/actix_identity/error/struct.SessionExpiryError.html
index 67e70971f..ce47fd2f9 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 af1da7c72..7ddae01f6 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 c1f1556d1..eef832bbf 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 46c161c02..bad5840b6 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 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§
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),
@@ -22,8 +22,8 @@
E: Error + ?Sized,
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/index.html b/actix_limitation/index.html
index ea911a647..12484ac7d 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.4"
diff --git a/actix_limitation/struct.Builder.html b/actix_limitation/struct.Builder.html
index c42799b27..1ea669366 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 56c402fd7..5718ab99b 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 b32f479be..72837b728 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 ae86ec3c9..ec6d6c44b 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§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_protobuf/all.html b/actix_protobuf/all.html
index 94c6a4269..c780b8809 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
List of all items in this crate List of all items
Structs
Enums
Traits
ProtoBufPayloadError in actix_protobuf - Rust