diff --git a/actix_cors/all.html b/actix_cors/all.html index 79450b53b..5bd8115ed 100644 --- a/actix_cors/all.html +++ b/actix_cors/all.html @@ -1 +1 @@ -
#[non_exhaustive]pub enum CorsError {
+CorsError in actix_cors - Rust Enum actix_cors::CorsError
source · #[non_exhaustive]pub enum CorsError {
WildcardOrigin,
MissingOrigin,
MissingRequestMethod,
@@ -16,7 +16,7 @@
§OriginNotAllowed
Origin is not allowed to make this request.
§MethodNotAllowed
Request method is not allowed.
§HeadersNotAllowed
One or more request headers are not allowed.
-
Returns the argument unchanged.
diff --git a/actix_cors/index.html b/actix_cors/index.html index a94cc3863..9724e801a 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
diff --git a/actix_identity/all.html b/actix_identity/all.html
index e50b0c6be..8e3dd6fa6 100644
--- a/actix_identity/all.html
+++ b/actix_identity/all.html
@@ -1 +1 @@
-
#[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 3a0f9c969..a5a5a606d 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§
- 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
invoked.
\ No newline at end of file
diff --git a/actix_identity/config/struct.IdentityMiddlewareBuilder.html b/actix_identity/config/struct.IdentityMiddlewareBuilder.html
index 366100109..be908e616 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
sourcepub fn id_key(self, key: &'static str) -> Self
Set a custom key to identify the user in the session.
diff --git a/actix_identity/error/enum.GetIdentityError.html b/actix_identity/error/enum.GetIdentityError.html
index 9f3e4dc55..82087da1f 100644
--- a/actix_identity/error/enum.GetIdentityError.html
+++ b/actix_identity/error/enum.GetIdentityError.html
@@ -1,15 +1,15 @@
-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),
+ 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 Freeze for GetIdentityError
§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 Freeze for GetIdentityError
§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 8bfb20f7a..fe190e9c4 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§
- 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.
\ No newline at end of file
diff --git a/actix_identity/error/struct.LoginError.html b/actix_identity/error/struct.LoginError.html
index f2eb5bb9f..901bfe26b 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§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 Freeze for LoginError
§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> 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§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 Freeze for LoginError
§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 453553acb..0adb78cbf 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§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 Freeze for LostIdentityError
§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> Borrow<T> for Twhere
diff --git a/actix_identity/error/struct.MissingIdentityError.html b/actix_identity/error/struct.MissingIdentityError.html
index 20ac24148..04f560adf 100644
--- a/actix_identity/error/struct.MissingIdentityError.html
+++ b/actix_identity/error/struct.MissingIdentityError.html
@@ -1,5 +1,5 @@
-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 Freeze for MissingIdentityError
§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> Any for Twhere
+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 Freeze for MissingIdentityError
§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 42422bf8f..787e2f4a5 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 Struct actix_identity::error::SessionExpiryError
source · pub struct SessionExpiryError(/* private fields */);
Expand description
Error encountered when working with a session that has expired.
+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 Freeze for SessionExpiryError
§impl RefUnwindSafe for SessionExpiryError
§impl Send for SessionExpiryError
§impl Sync for SessionExpiryError
§impl Unpin for SessionExpiryError
§impl UnwindSafe for SessionExpiryError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
diff --git a/actix_identity/index.html b/actix_identity/index.html
index cbae06107..18d3dec5b 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 f333fac1a..906a4c86a 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 82f8b576d..0c2f07fbb 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 f59dff84b..ac32eed24 100644
--- a/actix_identity/trait.IdentityExt.html
+++ b/actix_identity/trait.IdentityExt.html
@@ -1,4 +1,4 @@
-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.
diff --git a/actix_limitation/all.html b/actix_limitation/all.html
index f66c0010f..dfdbb90b5 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 15b973f10..786b45539 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 233d62db4..7d9d9bc7f 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 c1acac825..a0e3ac87d 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 852939cd2..f708add70 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 021e5001a..ec69a8f54 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 Error for Error
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()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
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()Auto Trait Implementations§
§impl Freeze for Error
§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> 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_limitation/index.html b/actix_limitation/index.html
index 1d75cd090..560666170 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 5c9518fe4..32de19dfd 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
sourcepub 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 0a31301f1..bac22b8bc 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
sourcepub 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 537cc341a..d2707acaf 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