diff --git a/actix_cors/all.html b/actix_cors/all.html index 7a927f691..e2605648c 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 e69eebf43..b1fe659d2 100644 --- a/actix_cors/enum.CorsError.html +++ b/actix_cors/enum.CorsError.html @@ -1,4 +1,4 @@ -CorsError in actix_cors - Rust
#[non_exhaustive]
pub enum CorsError { +CorsError in actix_cors - Rust
#[non_exhaustive]
pub enum CorsError { WildcardOrigin, MissingOrigin, MissingRequestMethod, diff --git a/actix_cors/index.html b/actix_cors/index.html index 5aebc6d3d..80039df48 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 f1d97f478..8c07321c6 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 986326daf..00979dcfc 100644 --- a/actix_identity/all.html +++ b/actix_identity/all.html @@ -1 +1 @@ -List of all items in this crate

\ No newline at end of file +List of all items in this crate
\ No newline at end of file diff --git a/actix_identity/config/enum.LogoutBehaviour.html b/actix_identity/config/enum.LogoutBehaviour.html index 80abe1dc4..be6e79ef0 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
#[non_exhaustive]
pub enum LogoutBehaviour { +LogoutBehaviour in actix_identity::config - Rust
#[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 00e326d2f..2ca043d2d 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 29cb428bc..a0091b4f2 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
pub struct IdentityMiddlewareBuilder { /* private fields */ }
Expand description

A fluent builder to construct an IdentityMiddleware instance with custom configuration +IdentityMiddlewareBuilder in actix_identity::config - Rust

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 b47ad9225..ae54c58cb 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
#[non_exhaustive]
pub enum GetIdentityError { +GetIdentityError in actix_identity::error - Rust
#[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()
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()
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 ac5fd2f74..ab020b268 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 b395357fd..d55edd624 100644 --- a/actix_identity/error/struct.LoginError.html +++ b/actix_identity/error/struct.LoginError.html @@ -1,4 +1,4 @@ -LoginError in actix_identity::error - Rust
pub struct LoginError(/* private fields */);
Expand description

Error that can occur during login attempts.

+LoginError in actix_identity::error - Rust
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()
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 diff --git a/actix_identity/error/struct.LostIdentityError.html b/actix_identity/error/struct.LostIdentityError.html index 68d28d1d5..33a57f83b 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
#[non_exhaustive]
pub struct LostIdentityError;
Expand description

The identity information has been lost.

+LostIdentityError in actix_identity::error - Rust
#[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()
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 e755b6088..3a7248457 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
#[non_exhaustive]
pub struct MissingIdentityError;
Expand description

There is no identity information attached to the current session.

+MissingIdentityError in actix_identity::error - Rust
#[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()
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 ef5d05643..2e5f7643c 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
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()
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
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()
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 fd21fb7ac..4f89db11c 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 a2e03f56c..67d879ccc 100644 --- a/actix_identity/struct.Identity.html +++ b/actix_identity/struct.Identity.html @@ -1,4 +1,4 @@ -Identity in actix_identity - Rust
pub struct Identity(/* private fields */);
Expand description

A verified user identity. It can be used as a request extractor.

+Identity in actix_identity - Rust
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 9301e9c01..95336e183 100644 --- a/actix_identity/struct.IdentityMiddleware.html +++ b/actix_identity/struct.IdentityMiddleware.html @@ -1,4 +1,4 @@ -IdentityMiddleware in actix_identity - Rust
pub struct IdentityMiddleware { /* private fields */ }
Expand description

Identity management middleware.

+IdentityMiddleware in actix_identity - Rust
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 7a9b35a2c..77d0e8985 100644
--- a/actix_identity/trait.IdentityExt.html
+++ b/actix_identity/trait.IdentityExt.html
@@ -1,6 +1,6 @@
-IdentityExt in actix_identity - Rust
pub trait IdentityExt {
+IdentityExt in actix_identity - Rust
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§

impl IdentityExt for HttpRequest

source§

impl<'a> IdentityExt for GuardContext<'a>

Implementors§

\ No newline at end of file +

Implementations on Foreign Types§

source§

impl IdentityExt for HttpRequest

source§

impl IdentityExt for ServiceRequest

source§

impl<'a> IdentityExt for GuardContext<'a>

Implementors§

\ No newline at end of file diff --git a/actix_limitation/all.html b/actix_limitation/all.html index 8604f0dae..889491918 100644 --- a/actix_limitation/all.html +++ b/actix_limitation/all.html @@ -1 +1 @@ -List of all items in this crate
\ No newline at end of file +List of all items in this crate
\ 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 65a287a1e..d5cecac90 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
pub const DEFAULT_COOKIE_NAME: &str = "sid";
Expand description

Default cookie name.

+DEFAULT_COOKIE_NAME in actix_limitation - Rust
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 5e57dc930..475cd87ef 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
pub const DEFAULT_PERIOD_SECS: u64 = 3600;
Expand description

Default period (in seconds).

+DEFAULT_PERIOD_SECS in actix_limitation - Rust
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 9b32063cb..ea583749a 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
pub const DEFAULT_REQUEST_LIMIT: usize = 5000;
Expand description

Default request limit.

+DEFAULT_REQUEST_LIMIT in actix_limitation - Rust
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 ccff9e7bf..5d86783cc 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
pub const DEFAULT_SESSION_KEY: &str = "rate-api-id";
Expand description

Default session key.

+DEFAULT_SESSION_KEY in actix_limitation - Rust
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 0606ab1d6..4578d2207 100644 --- a/actix_limitation/enum.Error.html +++ b/actix_limitation/enum.Error.html @@ -1,4 +1,4 @@ -Error in actix_limitation - Rust
pub enum Error {
+Error in actix_limitation - Rust
pub enum Error {
     Client(RedisError),
     LimitExceeded(Status),
     Time(ComponentRange),
diff --git a/actix_limitation/index.html b/actix_limitation/index.html
index ccac5b842..a0a99a0f2 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 903beab7b..a67d85a2c 100644
--- a/actix_limitation/struct.Builder.html
+++ b/actix_limitation/struct.Builder.html
@@ -1,4 +1,4 @@
-Builder in actix_limitation - Rust
pub struct Builder { /* private fields */ }
Expand description

Rate limiter builder.

+Builder in actix_limitation - Rust
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 cbee63069..2fd6130af 100644 --- a/actix_limitation/struct.Limiter.html +++ b/actix_limitation/struct.Limiter.html @@ -1,4 +1,4 @@ -Limiter in actix_limitation - Rust
pub struct Limiter { /* private fields */ }
Expand description

Rate limiter.

+Limiter in actix_limitation - Rust
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 0e4ec0e7b..a0c2c8e23 100644 --- a/actix_limitation/struct.RateLimiter.html +++ b/actix_limitation/struct.RateLimiter.html @@ -1,4 +1,4 @@ -RateLimiter in actix_limitation - Rust
#[non_exhaustive]
pub struct RateLimiter;
Expand description

Rate limit middleware.

+RateLimiter in actix_limitation - Rust
#[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 5697bd2bb..d72f4681e 100644 --- a/actix_limitation/struct.Status.html +++ b/actix_limitation/struct.Status.html @@ -1,4 +1,4 @@ -Status in actix_limitation - Rust
pub struct Status { /* private fields */ }
Expand description

A report for a given key containing the limit status.

+Status in actix_limitation - Rust
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 abce6d630..0a764ecd7 100644 --- a/actix_protobuf/all.html +++ b/actix_protobuf/all.html @@ -1 +1 @@ -List of all items in this crate
\ No newline at end of file +List of all items in this crate
\ No newline at end of file diff --git a/actix_protobuf/enum.ProtoBufPayloadError.html b/actix_protobuf/enum.ProtoBufPayloadError.html index d464fe59a..65076f452 100644 --- a/actix_protobuf/enum.ProtoBufPayloadError.html +++ b/actix_protobuf/enum.ProtoBufPayloadError.html @@ -1,4 +1,4 @@ -ProtoBufPayloadError in actix_protobuf - Rust

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 e7c51763a..8f08b13c3 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
\ No newline at end of file diff --git a/actix_protobuf/struct.ProtoBuf.html b/actix_protobuf/struct.ProtoBuf.html index 0239d02f9..1232da1c0 100644 --- a/actix_protobuf/struct.ProtoBuf.html +++ b/actix_protobuf/struct.ProtoBuf.html @@ -1,4 +1,4 @@ -ProtoBuf in actix_protobuf - Rust
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
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 494269741..8b0c2d3c0 100644 --- a/actix_protobuf/struct.ProtoBufConfig.html +++ b/actix_protobuf/struct.ProtoBufConfig.html @@ -1,4 +1,4 @@ -ProtoBufConfig in actix_protobuf - Rust
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
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 49e4fc335..03109d8b3 100644 --- a/actix_protobuf/struct.ProtoBufMessage.html +++ b/actix_protobuf/struct.ProtoBufMessage.html @@ -1,4 +1,4 @@ -ProtoBufMessage in actix_protobuf - Rust
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
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 61292cb0b..8736c2c6d 100644 --- a/actix_protobuf/trait.ProtoBufResponseBuilder.html +++ b/actix_protobuf/trait.ProtoBufResponseBuilder.html @@ -1,4 +1,4 @@ -ProtoBufResponseBuilder in actix_protobuf - Rust
pub trait ProtoBufResponseBuilder {
+ProtoBufResponseBuilder in actix_protobuf - Rust
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 8715698fc..06ed6ad43 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 60e9420b0..4e486ab51 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 fde3060f4..3d4503453 100644
--- a/actix_redis/enum.RespError.html
+++ b/actix_redis/enum.RespError.html
@@ -1,4 +1,4 @@
-RespError in actix_redis - Rust
pub enum RespError {
+RespError in actix_redis - Rust
pub enum RespError {
     Internal(String),
     IO(Arc<Error, Global>),
     Resp(String, Option<RespValue>),
diff --git a/actix_redis/enum.RespValue.html b/actix_redis/enum.RespValue.html
index e2ad7d47e..704db555d 100644
--- a/actix_redis/enum.RespValue.html
+++ b/actix_redis/enum.RespValue.html
@@ -1,4 +1,4 @@
-RespValue in actix_redis - Rust

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 4e7837e80..64512600b 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

  • 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

  • General purpose actix-redis error.
  • 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 a7b7d4b6d..3c9fa659d 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_rules! resp_array {
+resp_array in actix_redis - Rust
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 a57586405..45c5fed2b 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 f81d03552..338e24acf 100644 --- a/actix_redis/struct.RedisActor.html +++ b/actix_redis/struct.RedisActor.html @@ -1,14 +1,14 @@ -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 + 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 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/all.html b/actix_session/all.html index 0ad78992a..1e31b8e73 100644 --- a/actix_session/all.html +++ b/actix_session/all.html @@ -1 +1 @@ -List of all items in this crate
\ No newline at end of file +List of all items in this crate
\ No newline at end of file diff --git a/actix_session/config/enum.CookieContentSecurity.html b/actix_session/config/enum.CookieContentSecurity.html index b287cb8a6..f5b32f186 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
pub enum CookieContentSecurity {
+CookieContentSecurity in actix_session::config - Rust
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 e8141e496..63de50072 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
#[non_exhaustive]
pub enum SessionLifecycle { +SessionLifecycle in actix_session::config - Rust
#[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.

diff --git a/actix_session/config/enum.TtlExtensionPolicy.html b/actix_session/config/enum.TtlExtensionPolicy.html index 197fcb096..55eed3a33 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
#[non_exhaustive]
pub enum TtlExtensionPolicy { +TtlExtensionPolicy in actix_session::config - Rust
#[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 6e575bba5..0d468cc53 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

  • Determines how to secure the content of the session cookie.
  • Determines what type of session cookie should be used and how its lifecycle should be managed.
  • 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 3633183e5..fcb65f24d 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
pub struct BrowserSession { /* private fields */ }
Expand description

A session lifecycle strategy where the session cookie expires when the +BrowserSession in actix_session::config - Rust

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 1537fe569..91c6db129 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

pub struct PersistentSession { /* private fields */ }
Expand description

A session lifecycle strategy where the session cookie will be persistent.

+PersistentSession in actix_session::config - Rust
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 7945aee48..e02ab97a3 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

pub struct SessionMiddlewareBuilder<Store: SessionStore> { /* private fields */ }
Expand description

A fluent, customized SessionMiddleware builder.

+SessionMiddlewareBuilder in actix_session::config - Rust
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 d46dcff8f..ef1296a6a 100644 --- a/actix_session/enum.SessionStatus.html +++ b/actix_session/enum.SessionStatus.html @@ -1,4 +1,4 @@ -SessionStatus in actix_session - Rust
pub enum SessionStatus {
+SessionStatus in actix_session - Rust
pub enum SessionStatus {
     Changed,
     Purged,
     Renewed,
diff --git a/actix_session/index.html b/actix_session/index.html
index 652076aad..65a29b965 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 293c2ed19..da7c244b9 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

pub enum LoadError {
+LoadError in actix_session::storage - Rust
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()
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()
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 88ef67d54..86b858345 100644 --- a/actix_session/storage/enum.SaveError.html +++ b/actix_session/storage/enum.SaveError.html @@ -1,4 +1,4 @@ -SaveError in actix_session::storage - Rust
pub enum SaveError {
+SaveError in actix_session::storage - Rust
pub enum SaveError {
     Serialization(Error),
     Other(Error),
 }
Expand description

Possible failures modes for SessionStore::save.

diff --git a/actix_session/storage/enum.UpdateError.html b/actix_session/storage/enum.UpdateError.html index 347cb8932..2d195e56c 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
pub enum UpdateError {
+UpdateError in actix_session::storage - Rust
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()
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()
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 1a9056f3b..36b0e71e1 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