List of all items[−]
+List of all items in this crate List of all items[−]
Structs
Enums
CorsError in actix_cors - Rust Enum actix_cors::CorsError [−][src]
#[non_exhaustive]
+CorsError in actix_cors - Rust Enum actix_cors::CorsError [−][src]
#[non_exhaustive]
pub enum CorsError {
WildcardOrigin,
MissingOrigin,
@@ -9,16 +9,16 @@ pub enum CorsError {
MethodNotAllowed,
HeadersNotAllowed,
}
Expand description
Errors that can occur when processing CORS guarded requests.
-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.Allowed origin argument must not be wildcard (*).
-Request header Origin is required but was not provided.
-Request header Access-Control-Request-Method is required but is missing.
-Request header Access-Control-Request-Method has an invalid value.
-Request header Access-Control-Request-Headers has an invalid value.
-Origin is not allowed to make this request.
-Request method is not allowed.
-One or more request headers are not allowed.
+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.WildcardOrigin
Allowed origin argument must not be wildcard (*).
+MissingOrigin
Request header Origin is required but was not provided.
+MissingRequestMethod
Request header Access-Control-Request-Method is required but is missing.
+BadRequestMethod
Request header Access-Control-Request-Method has an invalid value.
+BadRequestHeaders
Request header Access-Control-Request-Headers has an invalid value.
+OriginNotAllowed
Origin is not allowed to make this request.
+MethodNotAllowed
Request method is not allowed.
+HeadersNotAllowed
One or more request headers are not allowed.
Trait Implementations
The lower-level source of this error, if any. Read more
@@ -41,7 +41,7 @@ pub enum CorsError {
Creates owned data from borrowed data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (toowned_clone_into)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
-
The type returned in the event of a conversion error.
diff --git a/actix_cors/index.html b/actix_cors/index.html
index db5bcc026..d1a206826 100644
--- a/actix_cors/index.html
+++ b/actix_cors/index.html
@@ -1,4 +1,4 @@
-actix_cors - Rust Crate actix_cors[−][src]
Expand description
Cross-Origin Resource Sharing (CORS) controls for Actix Web.
+actix_cors - Rust Crate actix_cors[−][src]
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 8863933d8..fa0e7070d 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 [−][src]
pub struct Cors { /* fields omitted */ }
Expand description
Builder for CORS middleware.
+Cors in actix_cors - Rust Struct actix_cors::Cors [−][src]
pub struct Cors { /* fields omitted */ }
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 d75bbdde8..ef6742f9f 100644
--- a/actix_identity/all.html
+++ b/actix_identity/all.html
@@ -1,4 +1,4 @@
-
List of all items in this crate List of all items[−]
+List of all items in this crate List of all items[−]
Structs
Traits
actix_identity - Rust Crate actix_identity[−][src]
Expand description
Opinionated request identity service for Actix Web apps.
+actix_identity - Rust Crate actix_identity[−][src]
Expand description
Opinionated request identity service for Actix Web apps.
IdentityService middleware can be used with different policies types to store
identity information.
A cookie based policy is provided. CookieIdentityPolicy uses cookies as identity storage.
diff --git a/actix_identity/struct.CookieIdentityPolicy.html b/actix_identity/struct.CookieIdentityPolicy.html
index ce9e6cb7b..95af913fd 100644
--- a/actix_identity/struct.CookieIdentityPolicy.html
+++ b/actix_identity/struct.CookieIdentityPolicy.html
@@ -1,4 +1,4 @@
-CookieIdentityPolicy in actix_identity - Rust Struct actix_identity::CookieIdentityPolicy [−][src]
pub struct CookieIdentityPolicy(_);
Expand description
Use cookies for request identity storage.
+CookieIdentityPolicy in actix_identity - Rust Struct actix_identity::CookieIdentityPolicy [−][src]
pub struct CookieIdentityPolicy(_);
Expand description
Use cookies for request identity storage.
See this page on MDN for details on cookie attributes.
Examples
use actix_web::App;
@@ -44,7 +44,7 @@ into the issued cookies, making it immutable to users.
type ResponseFuture = Ready<Result<(), Error>>
The return type of the middleware
Parse the session from request and load data from a service identity.
fn to_response<B>(
&self,
id: Option<String>,
changed: bool,
res: &mut ServiceResponse<B>
) -> Self::ResponseFuture
Write changes to response
-Auto Trait Implementations
impl !RefUnwindSafe for CookieIdentityPolicy
impl !Send for CookieIdentityPolicy
impl !Sync for CookieIdentityPolicy
impl Unpin for CookieIdentityPolicy
impl UnwindSafe for CookieIdentityPolicy
Blanket Implementations
Auto Trait Implementations
impl RefUnwindSafe for CookieIdentityPolicy
impl !Send for CookieIdentityPolicy
impl !Sync for CookieIdentityPolicy
impl Unpin for CookieIdentityPolicy
impl UnwindSafe for CookieIdentityPolicy
Blanket Implementations
Mutably borrows from an owned value. Read more
Performs the conversion.
diff --git a/actix_identity/struct.Identity.html b/actix_identity/struct.Identity.html
index fda6c2f56..3f3257a7c 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 [−][src]
pub struct Identity(_);
Expand description
The extractor type to obtain your identity from a request.
+Identity in actix_identity - Rust Struct actix_identity::Identity [−][src]
pub struct Identity(_);
Expand description
The extractor type to obtain your identity from a request.
use actix_web::*;
use actix_identity::Identity;
@@ -33,7 +33,7 @@ found associated with the request.
Trait Implementations
Extractor implementation for Identity type.
use actix_identity::Identity;
diff --git a/actix_identity/struct.IdentityService.html b/actix_identity/struct.IdentityService.html
index 9cb50ce28..b7f983af6 100644
--- a/actix_identity/struct.IdentityService.html
+++ b/actix_identity/struct.IdentityService.html
@@ -1,4 +1,4 @@
-IdentityService in actix_identity - Rust Struct actix_identity::IdentityService [−][src]
pub struct IdentityService<T> { /* fields omitted */ }
Expand description
Request identity middleware
+IdentityService in actix_identity - Rust Struct actix_identity::IdentityService [−][src]
pub struct IdentityService<T> { /* fields omitted */ }
Expand description
Request identity middleware
use actix_web::App;
use actix_identity::{CookieIdentityPolicy, IdentityService};
@@ -18,7 +18,7 @@
type Transform = IdentityServiceMiddleware<S, T>
The TransformService value created by this factory
type Future = Ready<Result<Self::Transform, Self::InitError>>
The future response value.
Creates and returns a new Transform component, asynchronously
-Auto Trait Implementations
impl<T> !RefUnwindSafe for IdentityService<T>
impl<T> !Send for IdentityService<T>
impl<T> !Sync for IdentityService<T>
impl<T> Unpin for IdentityService<T>
impl<T> UnwindSafe for IdentityService<T> where
T: RefUnwindSafe,
Blanket Implementations
Auto Trait Implementations
impl<T> RefUnwindSafe for IdentityService<T> where
T: RefUnwindSafe,
impl<T> !Send for IdentityService<T>
impl<T> !Sync for IdentityService<T>
impl<T> Unpin for IdentityService<T>
impl<T> UnwindSafe for IdentityService<T> where
T: RefUnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Performs the conversion.
diff --git a/actix_identity/trait.IdentityPolicy.html b/actix_identity/trait.IdentityPolicy.html
index 1bca12b7d..2dcea2061 100644
--- a/actix_identity/trait.IdentityPolicy.html
+++ b/actix_identity/trait.IdentityPolicy.html
@@ -1,4 +1,4 @@
-IdentityPolicy in actix_identity - Rust Trait actix_identity::IdentityPolicy [−][src]
pub trait IdentityPolicy: Sized + 'static {
+IdentityPolicy in actix_identity - Rust Trait actix_identity::IdentityPolicy [−][src]
pub trait IdentityPolicy: Sized + 'static {
type Future: Future<Output = Result<Option<String>, Error>>;
type ResponseFuture: Future<Output = Result<(), Error>>;
fn from_request(&self, req: &mut ServiceRequest) -> Self::Future;
diff --git a/actix_identity/trait.RequestIdentity.html b/actix_identity/trait.RequestIdentity.html
index e73fceaf2..8eb50bc43 100644
--- a/actix_identity/trait.RequestIdentity.html
+++ b/actix_identity/trait.RequestIdentity.html
@@ -1,4 +1,4 @@
-RequestIdentity in actix_identity - Rust Trait actix_identity::RequestIdentity [−][src]
pub trait RequestIdentity {
+RequestIdentity in actix_identity - Rust Trait actix_identity::RequestIdentity [−][src]
pub trait RequestIdentity {
fn get_identity(&self) -> Option<String>;
}
Expand description
Helper trait that allows to get Identity.
It could be used in middleware but identity policy must be set before any other middleware that
diff --git a/actix_protobuf/all.html b/actix_protobuf/all.html
index 43b71f5bc..78b957fae 100644
--- a/actix_protobuf/all.html
+++ b/actix_protobuf/all.html
@@ -1,4 +1,4 @@
-
List of all items in this crate List of all items[−]
+List of all items in this crate List of all items[−]
Structs
Enums
Traits
ProtoBufPayloadError in actix_protobuf - Rust Enum actix_protobuf::ProtoBufPayloadError [−][src]
pub enum ProtoBufPayloadError {
+ProtoBufPayloadError in actix_protobuf - Rust Enum actix_protobuf::ProtoBufPayloadError [−][src]
pub enum ProtoBufPayloadError {
Overflow,
ContentType,
Serialize(ProtoBufEncodeError),
Deserialize(ProtoBufDecodeError),
Payload(PayloadError),
-}
Variants
Payload size is bigger than 256k
-Content type error
-Serialize(ProtoBufEncodeError)Serialize error
-Tuple Fields of Serialize
Deserialize(ProtoBufDecodeError)Deserialize error
-Tuple Fields of Deserialize
Payload error
-Trait Implementations
Formats the value using the given formatter. Read more
+}Variants
Overflow
Payload size is bigger than 256k
+ContentType
Content type error
+Serialize(ProtoBufEncodeError)
Tuple Fields
Serialize error
+Deserialize(ProtoBufDecodeError)
Tuple Fields
Deserialize error
+Payload(PayloadError)
Payload error
+Trait Implementations
Performs the conversion.
The type returned in the event of a conversion error.
diff --git a/actix_protobuf/index.html b/actix_protobuf/index.html
index cace43adf..fd215af86 100644
--- a/actix_protobuf/index.html
+++ b/actix_protobuf/index.html
@@ -1,4 +1,4 @@
-actix_protobuf - Rust Crate actix_protobuf[−][src]
Structs
+actix_protobuf - Rust Crate actix_protobuf[−][src]
Structs
Enums
Traits
ProtoBuf in actix_protobuf - Rust Struct actix_protobuf::ProtoBuf [−][src]
pub struct ProtoBuf<T: Message>(pub T);
Tuple Fields
0: TTrait Implementations
Formats the value using the given formatter. Read more
+ProtoBuf in actix_protobuf - Rust Struct actix_protobuf::ProtoBuf [−][src]
pub struct ProtoBuf<T: Message>(pub T);
Tuple Fields
0: TTrait Implementations
The type returned in the event of a conversion error.
diff --git a/actix_protobuf/struct.ProtoBufConfig.html b/actix_protobuf/struct.ProtoBufConfig.html
index c753a00df..cbebef460 100644
--- a/actix_protobuf/struct.ProtoBufConfig.html
+++ b/actix_protobuf/struct.ProtoBufConfig.html
@@ -1,4 +1,4 @@
-ProtoBufConfig in actix_protobuf - Rust Struct actix_protobuf::ProtoBufConfig [−][src]
pub struct ProtoBufConfig { /* fields omitted */ }
Implementations
Change max size of payload. By default max size is 256Kb
+ProtoBufConfig in actix_protobuf - Rust Struct actix_protobuf::ProtoBufConfig [−][src]
pub struct ProtoBufConfig { /* fields omitted */ }
Implementations
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for ProtoBufConfig
impl Send for ProtoBufConfig
impl Sync for ProtoBufConfig
impl Unpin for ProtoBufConfig
impl UnwindSafe for ProtoBufConfig
Blanket Implementations
Immutably borrows from an owned value. Read more
diff --git a/actix_protobuf/struct.ProtoBufMessage.html b/actix_protobuf/struct.ProtoBufMessage.html
index 2e74a4f88..cd3f23864 100644
--- a/actix_protobuf/struct.ProtoBufMessage.html
+++ b/actix_protobuf/struct.ProtoBufMessage.html
@@ -1,4 +1,4 @@
-ProtoBufMessage in actix_protobuf - Rust Struct actix_protobuf::ProtoBufMessage [−][src]
Implementations
Create ProtoBufMessage for request.
+ProtoBufMessage in actix_protobuf - Rust Struct actix_protobuf::ProtoBufMessage [−][src]
Implementations
Trait Implementations
type Output = Result<T, ProtoBufPayloadError>
The type of value produced on completion.
Attempt to resolve the future to a final value, registering
diff --git a/actix_protobuf/trait.ProtoBufResponseBuilder.html b/actix_protobuf/trait.ProtoBufResponseBuilder.html
index 88e310e60..b309f3c8f 100644
--- a/actix_protobuf/trait.ProtoBufResponseBuilder.html
+++ b/actix_protobuf/trait.ProtoBufResponseBuilder.html
@@ -1,4 +1,4 @@
-
ProtoBufResponseBuilder in actix_protobuf - Rust Trait actix_protobuf::ProtoBufResponseBuilder [−][src]
pub trait ProtoBufResponseBuilder {
+ProtoBufResponseBuilder in actix_protobuf - Rust Trait actix_protobuf::ProtoBufResponseBuilder [−][src]
pub trait ProtoBufResponseBuilder {
fn protobuf<T: Message>(&mut self, value: T) -> Result<HttpResponse, Error>;
}
Required methods
Implementations on Foreign Types
Implementors
List of all items in this crate List of all items[−]
+List of all items in this crate List of all items[−]
Structs
Enums
Error in actix_redis - Rust Enum actix_redis::Error [−][src]
pub enum Error {
+Error in actix_redis - Rust Enum actix_redis::Error [−][src]
pub enum Error {
Redis(Error),
NotConnected,
Disconnected,
}
Expand description
General purpose actix redis error
-Variants
Redis(Error)Tuple Fields of Redis
0: ErrorReceiving message during reconnecting
-Cancel all waters when connection get dropped
+Variants
Redis(Error)
Tuple Fields
0: ErrorNotConnected
Receiving message during reconnecting
+Disconnected
Cancel all waters when connection get dropped
Trait Implementations
fn status_code(&self) -> StatusCode
Returns appropriate status code for error. Read more
-fn error_response(&self) -> HttpResponse<AnyBody>
Creates full response for error. Read more
+fn error_response(&self) -> HttpResponse<AnyBody<BoxBody>>
Creates full response for error. Read more
Auto Trait Implementations
impl !RefUnwindSafe for Error
impl !UnwindSafe for Error
Blanket Implementations
The type returned in the event of a conversion error.
diff --git a/actix_redis/enum.RespError.html b/actix_redis/enum.RespError.html
index 87e76480d..8a6da7777 100644
--- a/actix_redis/enum.RespError.html
+++ b/actix_redis/enum.RespError.html
@@ -1,22 +1,22 @@
-RespError in actix_redis - Rust Enum actix_redis::RespError [−]
pub enum RespError {
+RespError in actix_redis - Rust Enum actix_redis::RespError [−]
pub enum RespError {
Internal(String),
IO(Error),
RESP(String, Option<RespValue>),
Remote(String),
Connection(ConnectionReason),
Unexpected(String),
-}
Variants
Internal(String)A non-specific internal error that prevented an operation from completing
-Tuple Fields of Internal
0: StringIO(Error)An IO error occurred
-Tuple Fields of IO
0: ErrorA RESP parsing/serialising error occurred
-Remote(String)A remote error
-Tuple Fields of Remote
0: StringError creating a connection, or an error with a connection being closed unexpectedly
-Unexpected(String)An unexpected error. In this context “unexpected” means
+}
Variants
Internal(String)
Tuple Fields
0: StringA non-specific internal error that prevented an operation from completing
+IO(Error)
Tuple Fields
0: ErrorAn IO error occurred
+RESP(String, Option<RespValue>)
A RESP parsing/serialising error occurred
+Remote(String)
Tuple Fields
0: StringA remote error
+Connection(ConnectionReason)
Error creating a connection, or an error with a connection being closed unexpectedly
+Unexpected(String)
Tuple Fields
0: StringAn unexpected error. In this context “unexpected” means
“unexpected because we check ahead of time”, it used to maintain the type signature of
chains of futures; but it occurring at runtime should be considered a catastrophic
failure.
If any error is propagated this way that needs to be handled, then it should be made into
a proper option.
-Tuple Fields of Unexpected
0: StringTrait Implementations
Formats the value using the given formatter. Read more
+Trait Implementations
The lower-level source of this error, if any. Read more
The type returned in the event of a conversion error.
diff --git a/actix_redis/enum.RespValue.html b/actix_redis/enum.RespValue.html
index 90deb48a9..75988ff9f 100644
--- a/actix_redis/enum.RespValue.html
+++ b/actix_redis/enum.RespValue.html
@@ -1,4 +1,4 @@
-RespValue in actix_redis - Rust Enum actix_redis::RespValue [−]
pub enum RespValue {
+RespValue in actix_redis - Rust Enum actix_redis::RespValue [−]
pub enum RespValue {
Nil,
Array(Vec<RespValue, Global>),
BulkString(Vec<u8, Global>),
@@ -8,27 +8,27 @@
}
Expand description
A single RESP value, this owns the data that is read/to-be written to Redis.
It is cloneable to allow multiple copies to be delivered in certain circumstances, e.g. multiple
subscribers to the same topic.
-Variants
Zero, one or more other RespValues.
-A bulk string. In Redis terminology a string is a byte-array, so this is stored as a
+
Variants
Nil
Array(Vec<RespValue, Global>)
Zero, one or more other RespValues.
+BulkString(Vec<u8, Global>)
A bulk string. In Redis terminology a string is a byte-array, so this is stored as a
vector of u8s to allow clients to interpret the bytes as appropriate.
-Error(String)An error from the Redis server
-Tuple Fields of Error
0: StringInteger(i64)Redis documentation defines an integer as being a signed 64-bit integer:
+
Error(String)
Tuple Fields
0: StringAn error from the Redis server
+Integer(i64)
Tuple Fields
0: i64Redis documentation defines an integer as being a signed 64-bit integer:
https://redis.io/topics/protocol#resp-integers
-Tuple Fields of Integer
0: i64SimpleString(String)Tuple Fields of SimpleString
0: StringImplementations
impl RespValue
pub fn append<T>(self, other: impl IntoIterator<Item = T>) -> RespValue where
T: Into<RespValue>,
Convenience function for building dynamic Redis commands with variable numbers of
+
SimpleString(String)
Tuple Fields
0: StringImplementations
impl RespValue
pub fn append<T>(self, other: impl IntoIterator<Item = T>) -> RespValue where
T: Into<RespValue>,
Convenience function for building dynamic Redis commands with variable numbers of
arguments, e.g. RPUSH
This will panic if called for anything other than arrays
Trait Implementations
This method tests for self and other values to be equal, and is used
diff --git a/actix_redis/enum.SameSite.html b/actix_redis/enum.SameSite.html
index 5453961e7..acd1a578e 100644
--- a/actix_redis/enum.SameSite.html
+++ b/actix_redis/enum.SameSite.html
@@ -1,4 +1,4 @@
-
SameSite in actix_redis - Rust Enum actix_redis::SameSite [−][src]
pub enum SameSite {
+SameSite in actix_redis - Rust Enum actix_redis::SameSite [−][src]
pub enum SameSite {
Strict,
Lax,
None,
@@ -18,9 +18,9 @@ initally or passing None to HTTP draft! Its meaning and
definition are subject to change.
-
Variants
The “Strict” SameSite attribute.
-The “Lax” SameSite attribute.
-The “None” SameSite attribute.
+Variants
Strict
The “Strict” SameSite attribute.
+Lax
The “Lax” SameSite attribute.
+None
The “None” SameSite attribute.
Implementations
Trait Implementations
This method tests for self and other values to be equal, and is used
@@ -69,7 +69,7 @@ by ==.
Creates owned data from borrowed data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (toowned_clone_into)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
-
The type returned in the event of a conversion error.
diff --git a/actix_redis/index.html b/actix_redis/index.html
index f1dc58f69..f4a9eb5c9 100644
--- a/actix_redis/index.html
+++ b/actix_redis/index.html
@@ -1,4 +1,4 @@
-actix_redis - Rust Crate actix_redis[−][src]
Expand description
Redis integration for Actix and session store for Actix Web.
+actix_redis - Rust Crate actix_redis[−][src]
Expand description
Redis integration for Actix and session store for Actix Web.
Structs
Command for send data to Redis
Redis communication actor
diff --git a/actix_redis/struct.Command.html b/actix_redis/struct.Command.html
index 613e35037..21d9591d9 100644
--- a/actix_redis/struct.Command.html
+++ b/actix_redis/struct.Command.html
@@ -1,4 +1,4 @@
-Command in actix_redis - Rust Struct actix_redis::Command [−][src]
pub struct Command(pub RespValue);
Expand description
Command for send data to Redis
+Command in actix_redis - Rust Struct actix_redis::Command [−][src]
pub struct Command(pub RespValue);
Expand description
Command for send data to Redis
Tuple Fields
0: RespValueTrait Implementations
The type of value that this handler will return. Read more
This method is called for every message received by this actor.
diff --git a/actix_redis/struct.RedisActor.html b/actix_redis/struct.RedisActor.html
index f542cef6d..9f3bb95be 100644
--- a/actix_redis/struct.RedisActor.html
+++ b/actix_redis/struct.RedisActor.html
@@ -1,4 +1,4 @@
-RedisActor in actix_redis - Rust Struct actix_redis::RedisActor [−][src]
pub struct RedisActor { /* fields omitted */ }
Expand description
Redis communication actor
+RedisActor in actix_redis - Rust Struct actix_redis::RedisActor [−][src]
pub struct RedisActor { /* fields omitted */ }
Expand description
Redis communication actor
Implementations
Start new Supervisor with RedisActor.
Trait Implementations
type Context = Context<Self>
Actor execution context type
Called when an actor gets polled the first time.
diff --git a/actix_redis/struct.RedisSession.html b/actix_redis/struct.RedisSession.html
index f74ee750b..149141161 100644
--- a/actix_redis/struct.RedisSession.html
+++ b/actix_redis/struct.RedisSession.html
@@ -1,4 +1,4 @@
-RedisSession in actix_redis - Rust Struct actix_redis::RedisSession [−][src]
pub struct RedisSession(_);
Expand description
Use redis as session storage.
+RedisSession in actix_redis - Rust Struct actix_redis::RedisSession [−][src]
pub struct RedisSession(_);
Expand description
Use redis as session storage.
You need to pass an address of the redis server and random value to the
constructor of RedisSession. This is private key for cookie
session, When this value is changed, all session data is lost.
diff --git a/actix_session/all.html b/actix_session/all.html
index 152b0185a..c174940d5 100644
--- a/actix_session/all.html
+++ b/actix_session/all.html
@@ -1,4 +1,4 @@
-List of all items in this crate List of all items[−]
+List of all items in this crate List of all items[−]
Structs
Enums
Traits
SessionStatus in actix_session - Rust Enum actix_session::SessionStatus [−][src]
pub enum SessionStatus {
+SessionStatus in actix_session - Rust Enum actix_session::SessionStatus [−][src]
pub enum SessionStatus {
Changed,
Purged,
Renewed,
Unchanged,
}
Expand description
Status of a Session.
-Variants
Session has been updated and requires a new persist operation.
-Session is flagged for deletion and should be removed from client and server.
+Variants
Changed
Session has been updated and requires a new persist operation.
+Purged
Session is flagged for deletion and should be removed from client and server.
Most operations on the session after purge flag is set should have no effect.
-Session is flagged for refresh.
+Renewed
Session is flagged for refresh.
For example, when using a backend that has a TTL (time-to-live) expiry on the session entry,
the session will be refreshed even if no data inside it has changed. The client may also
be notified of the refresh.
-Session is unchanged from when last seen (if exists).
+Unchanged
Session is unchanged from when last seen (if exists).
This state also captures new (previously unissued) sessions such as a user’s first
site visit.
Trait Implementations
Returns the “default value” for a type. Read more
This method tests for self and other values to be equal, and is used
diff --git a/actix_session/index.html b/actix_session/index.html
index 9fefb93fa..b84ce77f5 100644
--- a/actix_session/index.html
+++ b/actix_session/index.html
@@ -1,4 +1,4 @@
-
actix_session - Rust Crate actix_session[−][src]
Expand description
Sessions for Actix Web.
+actix_session - Rust Crate actix_session[−][src]
Expand description
Sessions for Actix Web.
Provides a general solution for session management. Session middleware could provide different
implementations which could be accessed via general session API.
This crate provides a general solution for session management and includes a cookie backend.
diff --git a/actix_session/struct.CookieSession.html b/actix_session/struct.CookieSession.html
index 138ddba33..6b84685ac 100644
--- a/actix_session/struct.CookieSession.html
+++ b/actix_session/struct.CookieSession.html
@@ -1,4 +1,4 @@
-
CookieSession in actix_session - Rust Struct actix_session::CookieSession [−][src]
pub struct CookieSession(_);
Expand description
Use cookies for session storage.
+CookieSession in actix_session - Rust Struct actix_session::CookieSession [−][src]
pub struct CookieSession(_);
Expand description
Use cookies for session storage.
CookieSession creates sessions which are limited to storing
fewer than 4000 bytes of data (as the payload must fit into a single
cookie). An Internal Server Error is generated if the session contains more
@@ -48,14 +48,14 @@ connection is secure - i.e. https
Sets the expires field in the session cookie being built.
Sets the expires field in the session cookie being built.
Trait Implementations
impl<S, B> Transform<S, ServiceRequest> for CookieSession where
S: Service<ServiceRequest, Response = ServiceResponse<B>>,
S::Future: 'static,
S::Error: 'static,
B: MessageBody + 'static,
B::Error: StdError,
Auto Trait Implementations
impl !RefUnwindSafe for CookieSession
impl !Send for CookieSession
impl !Sync for CookieSession
impl Unpin for CookieSession
impl UnwindSafe for CookieSession
Blanket Implementations
Auto Trait Implementations
impl RefUnwindSafe for CookieSession
impl !Send for CookieSession
impl !Sync for CookieSession
impl Unpin for CookieSession
impl UnwindSafe for CookieSession
Blanket Implementations
Mutably borrows from an owned value. Read more
Performs the conversion.
diff --git a/actix_session/struct.Session.html b/actix_session/struct.Session.html
index 3ebb2ae6e..7672f81d5 100644
--- a/actix_session/struct.Session.html
+++ b/actix_session/struct.Session.html
@@ -1,4 +1,4 @@
-Session in actix_session - Rust Struct actix_session::Session [−][src]
pub struct Session(_);
Expand description
The high-level interface you use to modify session data.
+Session in actix_session - Rust Struct actix_session::Session [−][src]
pub struct Session(_);
Expand description
The high-level interface you use to modify session data.
Session object is obtained with UserSession::get_session. The UserSession trait is
implemented for HttpRequest, ServiceRequest, and RequestHead.
@@ -36,12 +36,12 @@ already be JSON serialized.
let mut req = test::TestRequest::default().to_srv_request();
Session::set_session(
- &mut req,
+ &mut req,
vec![("counter".to_string(), serde_json::to_string(&0).unwrap())],
);
pub fn get_changes<B>(
res: &mut ServiceResponse<B>
) -> (SessionStatus, impl Iterator<Item = (String, String)>)
Returns session status and iterator of key-value pairs of changes.
Trait Implementations
Extractor implementation for Session type.
-Examples
+Examples
use actix_session::Session;
#[get("/")]
diff --git a/actix_session/trait.UserSession.html b/actix_session/trait.UserSession.html
index 7cc14115e..1ad06ebb8 100644
--- a/actix_session/trait.UserSession.html
+++ b/actix_session/trait.UserSession.html
@@ -1,4 +1,4 @@
-UserSession in actix_session - Rust Trait actix_session::UserSession [−][src]
pub trait UserSession {
+UserSession in actix_session - Rust Trait actix_session::UserSession [−][src]
pub trait UserSession {
fn get_session(&self) -> Session;
}
Expand description
Extraction of a Session object.
Required methods
fn get_session(&self) -> Session
Extract the Session object
diff --git a/actix_web_httpauth/all.html b/actix_web_httpauth/all.html
index f35234b99..3f16567c3 100644
--- a/actix_web_httpauth/all.html
+++ b/actix_web_httpauth/all.html
@@ -1,4 +1,4 @@
-List of all items in this crate List of all items[−]
+List of all items in this crate
List of all items[−]
Structs
Enums
Enum actix_cors::CorsError [−][src]
#[non_exhaustive]
+CorsError in actix_cors - Rust Enum actix_cors::CorsError [−][src]
#[non_exhaustive]
pub enum CorsError {
WildcardOrigin,
MissingOrigin,
@@ -9,16 +9,16 @@ pub enum CorsError {
MethodNotAllowed,
HeadersNotAllowed,
}
Expand description
Errors that can occur when processing CORS guarded requests.
-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.Allowed origin argument must not be wildcard (*).
-Request header Origin is required but was not provided.
-Request header Access-Control-Request-Method is required but is missing.
-Request header Access-Control-Request-Method has an invalid value.
-Request header Access-Control-Request-Headers has an invalid value.
-Origin is not allowed to make this request.
-Request method is not allowed.
-One or more request headers are not allowed.
+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.WildcardOrigin
Allowed origin argument must not be wildcard (*).
+MissingOrigin
Request header Origin is required but was not provided.
+MissingRequestMethod
Request header Access-Control-Request-Method is required but is missing.
+BadRequestMethod
Request header Access-Control-Request-Method has an invalid value.
+BadRequestHeaders
Request header Access-Control-Request-Headers has an invalid value.
+OriginNotAllowed
Origin is not allowed to make this request.
+MethodNotAllowed
Request method is not allowed.
+HeadersNotAllowed
One or more request headers are not allowed.
Trait Implementations
The lower-level source of this error, if any. Read more
@@ -41,7 +41,7 @@ pub enum CorsError {
Creates owned data from borrowed data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (toowned_clone_into)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
-
The type returned in the event of a conversion error.
diff --git a/actix_cors/index.html b/actix_cors/index.html
index db5bcc026..d1a206826 100644
--- a/actix_cors/index.html
+++ b/actix_cors/index.html
@@ -1,4 +1,4 @@
-actix_cors - Rust Crate actix_cors[−][src]
Expand description
Cross-Origin Resource Sharing (CORS) controls for Actix Web.
+actix_cors - Rust Crate actix_cors[−][src]
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 8863933d8..fa0e7070d 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 [−][src]
pub struct Cors { /* fields omitted */ }
Expand description
Builder for CORS middleware.
+Cors in actix_cors - Rust Struct actix_cors::Cors [−][src]
pub struct Cors { /* fields omitted */ }
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 d75bbdde8..ef6742f9f 100644
--- a/actix_identity/all.html
+++ b/actix_identity/all.html
@@ -1,4 +1,4 @@
-
List of all items in this crate List of all items[−]
+List of all items in this crate List of all items[−]
Structs
Traits
actix_identity - Rust Crate actix_identity[−][src]
Expand description
Opinionated request identity service for Actix Web apps.
+actix_identity - Rust Crate actix_identity[−][src]
Expand description
Opinionated request identity service for Actix Web apps.
IdentityService middleware can be used with different policies types to store
identity information.
A cookie based policy is provided. CookieIdentityPolicy uses cookies as identity storage.
diff --git a/actix_identity/struct.CookieIdentityPolicy.html b/actix_identity/struct.CookieIdentityPolicy.html
index ce9e6cb7b..95af913fd 100644
--- a/actix_identity/struct.CookieIdentityPolicy.html
+++ b/actix_identity/struct.CookieIdentityPolicy.html
@@ -1,4 +1,4 @@
-CookieIdentityPolicy in actix_identity - Rust Struct actix_identity::CookieIdentityPolicy [−][src]
pub struct CookieIdentityPolicy(_);
Expand description
Use cookies for request identity storage.
+CookieIdentityPolicy in actix_identity - Rust Struct actix_identity::CookieIdentityPolicy [−][src]
pub struct CookieIdentityPolicy(_);
Expand description
Use cookies for request identity storage.
See this page on MDN for details on cookie attributes.
Examples
use actix_web::App;
@@ -44,7 +44,7 @@ into the issued cookies, making it immutable to users.
type ResponseFuture = Ready<Result<(), Error>>
The return type of the middleware
Parse the session from request and load data from a service identity.
fn to_response<B>(
&self,
id: Option<String>,
changed: bool,
res: &mut ServiceResponse<B>
) -> Self::ResponseFuture
Write changes to response
-Auto Trait Implementations
impl !RefUnwindSafe for CookieIdentityPolicy
impl !Send for CookieIdentityPolicy
impl !Sync for CookieIdentityPolicy
impl Unpin for CookieIdentityPolicy
impl UnwindSafe for CookieIdentityPolicy
Blanket Implementations
Auto Trait Implementations
impl RefUnwindSafe for CookieIdentityPolicy
impl !Send for CookieIdentityPolicy
impl !Sync for CookieIdentityPolicy
impl Unpin for CookieIdentityPolicy
impl UnwindSafe for CookieIdentityPolicy
Blanket Implementations
Mutably borrows from an owned value. Read more
Performs the conversion.
diff --git a/actix_identity/struct.Identity.html b/actix_identity/struct.Identity.html
index fda6c2f56..3f3257a7c 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 [−][src]
pub struct Identity(_);
Expand description
The extractor type to obtain your identity from a request.
+Identity in actix_identity - Rust Struct actix_identity::Identity [−][src]
pub struct Identity(_);
Expand description
The extractor type to obtain your identity from a request.
use actix_web::*;
use actix_identity::Identity;
@@ -33,7 +33,7 @@ found associated with the request.
Trait Implementations
Extractor implementation for Identity type.
use actix_identity::Identity;
diff --git a/actix_identity/struct.IdentityService.html b/actix_identity/struct.IdentityService.html
index 9cb50ce28..b7f983af6 100644
--- a/actix_identity/struct.IdentityService.html
+++ b/actix_identity/struct.IdentityService.html
@@ -1,4 +1,4 @@
-IdentityService in actix_identity - Rust Struct actix_identity::IdentityService [−][src]
pub struct IdentityService<T> { /* fields omitted */ }
Expand description
Request identity middleware
+IdentityService in actix_identity - Rust Struct actix_identity::IdentityService [−][src]
pub struct IdentityService<T> { /* fields omitted */ }
Expand description
Request identity middleware
use actix_web::App;
use actix_identity::{CookieIdentityPolicy, IdentityService};
@@ -18,7 +18,7 @@
type Transform = IdentityServiceMiddleware<S, T>
The TransformService value created by this factory
type Future = Ready<Result<Self::Transform, Self::InitError>>
The future response value.
Creates and returns a new Transform component, asynchronously
-Auto Trait Implementations
impl<T> !RefUnwindSafe for IdentityService<T>
impl<T> !Send for IdentityService<T>
impl<T> !Sync for IdentityService<T>
impl<T> Unpin for IdentityService<T>
impl<T> UnwindSafe for IdentityService<T> where
T: RefUnwindSafe,
Blanket Implementations
Auto Trait Implementations
impl<T> RefUnwindSafe for IdentityService<T> where
T: RefUnwindSafe,
impl<T> !Send for IdentityService<T>
impl<T> !Sync for IdentityService<T>
impl<T> Unpin for IdentityService<T>
impl<T> UnwindSafe for IdentityService<T> where
T: RefUnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Performs the conversion.
diff --git a/actix_identity/trait.IdentityPolicy.html b/actix_identity/trait.IdentityPolicy.html
index 1bca12b7d..2dcea2061 100644
--- a/actix_identity/trait.IdentityPolicy.html
+++ b/actix_identity/trait.IdentityPolicy.html
@@ -1,4 +1,4 @@
-IdentityPolicy in actix_identity - Rust Trait actix_identity::IdentityPolicy [−][src]
pub trait IdentityPolicy: Sized + 'static {
+IdentityPolicy in actix_identity - Rust Trait actix_identity::IdentityPolicy [−][src]
pub trait IdentityPolicy: Sized + 'static {
type Future: Future<Output = Result<Option<String>, Error>>;
type ResponseFuture: Future<Output = Result<(), Error>>;
fn from_request(&self, req: &mut ServiceRequest) -> Self::Future;
diff --git a/actix_identity/trait.RequestIdentity.html b/actix_identity/trait.RequestIdentity.html
index e73fceaf2..8eb50bc43 100644
--- a/actix_identity/trait.RequestIdentity.html
+++ b/actix_identity/trait.RequestIdentity.html
@@ -1,4 +1,4 @@
-RequestIdentity in actix_identity - Rust Trait actix_identity::RequestIdentity [−][src]
pub trait RequestIdentity {
+RequestIdentity in actix_identity - Rust Trait actix_identity::RequestIdentity [−][src]
pub trait RequestIdentity {
fn get_identity(&self) -> Option<String>;
}
Expand description
Helper trait that allows to get Identity.
It could be used in middleware but identity policy must be set before any other middleware that
diff --git a/actix_protobuf/all.html b/actix_protobuf/all.html
index 43b71f5bc..78b957fae 100644
--- a/actix_protobuf/all.html
+++ b/actix_protobuf/all.html
@@ -1,4 +1,4 @@
-
List of all items in this crate List of all items[−]
+List of all items in this crate List of all items[−]
Structs
Enums
Traits
ProtoBufPayloadError in actix_protobuf - Rust Enum actix_protobuf::ProtoBufPayloadError [−][src]
pub enum ProtoBufPayloadError {
+ProtoBufPayloadError in actix_protobuf - Rust Enum actix_protobuf::ProtoBufPayloadError [−][src]
pub enum ProtoBufPayloadError {
Overflow,
ContentType,
Serialize(ProtoBufEncodeError),
Deserialize(ProtoBufDecodeError),
Payload(PayloadError),
-}
Variants
Payload size is bigger than 256k
-Content type error
-Serialize(ProtoBufEncodeError)Serialize error
-Tuple Fields of Serialize
Deserialize(ProtoBufDecodeError)Deserialize error
-Tuple Fields of Deserialize
Payload error
-Trait Implementations
Formats the value using the given formatter. Read more
+}Variants
Overflow
Payload size is bigger than 256k
+ContentType
Content type error
+Serialize(ProtoBufEncodeError)
Tuple Fields
Serialize error
+Deserialize(ProtoBufDecodeError)
Tuple Fields
Deserialize error
+Payload(PayloadError)
Payload error
+Trait Implementations
Performs the conversion.
The type returned in the event of a conversion error.
diff --git a/actix_protobuf/index.html b/actix_protobuf/index.html
index cace43adf..fd215af86 100644
--- a/actix_protobuf/index.html
+++ b/actix_protobuf/index.html
@@ -1,4 +1,4 @@
-actix_protobuf - Rust Crate actix_protobuf[−][src]
Structs
+actix_protobuf - Rust Crate actix_protobuf[−][src]
Structs
Enums
Traits
ProtoBuf in actix_protobuf - Rust Struct actix_protobuf::ProtoBuf [−][src]
pub struct ProtoBuf<T: Message>(pub T);
Tuple Fields
0: TTrait Implementations
Formats the value using the given formatter. Read more
+ProtoBuf in actix_protobuf - Rust Struct actix_protobuf::ProtoBuf [−][src]
pub struct ProtoBuf<T: Message>(pub T);
Tuple Fields
0: TTrait Implementations
The type returned in the event of a conversion error.
diff --git a/actix_protobuf/struct.ProtoBufConfig.html b/actix_protobuf/struct.ProtoBufConfig.html
index c753a00df..cbebef460 100644
--- a/actix_protobuf/struct.ProtoBufConfig.html
+++ b/actix_protobuf/struct.ProtoBufConfig.html
@@ -1,4 +1,4 @@
-ProtoBufConfig in actix_protobuf - Rust Struct actix_protobuf::ProtoBufConfig [−][src]
pub struct ProtoBufConfig { /* fields omitted */ }
Implementations
Change max size of payload. By default max size is 256Kb
+ProtoBufConfig in actix_protobuf - Rust Struct actix_protobuf::ProtoBufConfig [−][src]
pub struct ProtoBufConfig { /* fields omitted */ }
Implementations
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for ProtoBufConfig
impl Send for ProtoBufConfig
impl Sync for ProtoBufConfig
impl Unpin for ProtoBufConfig
impl UnwindSafe for ProtoBufConfig
Blanket Implementations
Immutably borrows from an owned value. Read more
diff --git a/actix_protobuf/struct.ProtoBufMessage.html b/actix_protobuf/struct.ProtoBufMessage.html
index 2e74a4f88..cd3f23864 100644
--- a/actix_protobuf/struct.ProtoBufMessage.html
+++ b/actix_protobuf/struct.ProtoBufMessage.html
@@ -1,4 +1,4 @@
-ProtoBufMessage in actix_protobuf - Rust Struct actix_protobuf::ProtoBufMessage [−][src]
Implementations
Create ProtoBufMessage for request.
+ProtoBufMessage in actix_protobuf - Rust Struct actix_protobuf::ProtoBufMessage [−][src]
Implementations
Trait Implementations
type Output = Result<T, ProtoBufPayloadError>
The type of value produced on completion.
Attempt to resolve the future to a final value, registering
diff --git a/actix_protobuf/trait.ProtoBufResponseBuilder.html b/actix_protobuf/trait.ProtoBufResponseBuilder.html
index 88e310e60..b309f3c8f 100644
--- a/actix_protobuf/trait.ProtoBufResponseBuilder.html
+++ b/actix_protobuf/trait.ProtoBufResponseBuilder.html
@@ -1,4 +1,4 @@
-
ProtoBufResponseBuilder in actix_protobuf - Rust Trait actix_protobuf::ProtoBufResponseBuilder [−][src]
pub trait ProtoBufResponseBuilder {
+ProtoBufResponseBuilder in actix_protobuf - Rust Trait actix_protobuf::ProtoBufResponseBuilder [−][src]
pub trait ProtoBufResponseBuilder {
fn protobuf<T: Message>(&mut self, value: T) -> Result<HttpResponse, Error>;
}
Required methods
Implementations on Foreign Types
Implementors
List of all items in this crate List of all items[−]
+List of all items in this crate List of all items[−]
Structs
Enums
Error in actix_redis - Rust Enum actix_redis::Error [−][src]
pub enum Error {
+Error in actix_redis - Rust Enum actix_redis::Error [−][src]
pub enum Error {
Redis(Error),
NotConnected,
Disconnected,
}
Expand description
General purpose actix redis error
-Variants
Redis(Error)Tuple Fields of Redis
0: ErrorReceiving message during reconnecting
-Cancel all waters when connection get dropped
+Variants
Redis(Error)
Tuple Fields
0: ErrorNotConnected
Receiving message during reconnecting
+Disconnected
Cancel all waters when connection get dropped
Trait Implementations
fn status_code(&self) -> StatusCode
Returns appropriate status code for error. Read more
-fn error_response(&self) -> HttpResponse<AnyBody>
Creates full response for error. Read more
+fn error_response(&self) -> HttpResponse<AnyBody<BoxBody>>
Creates full response for error. Read more
Auto Trait Implementations
impl !RefUnwindSafe for Error
impl !UnwindSafe for Error
Blanket Implementations
The type returned in the event of a conversion error.
diff --git a/actix_redis/enum.RespError.html b/actix_redis/enum.RespError.html
index 87e76480d..8a6da7777 100644
--- a/actix_redis/enum.RespError.html
+++ b/actix_redis/enum.RespError.html
@@ -1,22 +1,22 @@
-RespError in actix_redis - Rust Enum actix_redis::RespError [−]
pub enum RespError {
+RespError in actix_redis - Rust Enum actix_redis::RespError [−]
pub enum RespError {
Internal(String),
IO(Error),
RESP(String, Option<RespValue>),
Remote(String),
Connection(ConnectionReason),
Unexpected(String),
-}
Variants
Internal(String)A non-specific internal error that prevented an operation from completing
-Tuple Fields of Internal
0: StringIO(Error)An IO error occurred
-Tuple Fields of IO
0: ErrorA RESP parsing/serialising error occurred
-Remote(String)A remote error
-Tuple Fields of Remote
0: StringError creating a connection, or an error with a connection being closed unexpectedly
-Unexpected(String)An unexpected error. In this context “unexpected” means
+}
Variants
Internal(String)
Tuple Fields
0: StringA non-specific internal error that prevented an operation from completing
+IO(Error)
Tuple Fields
0: ErrorAn IO error occurred
+RESP(String, Option<RespValue>)
A RESP parsing/serialising error occurred
+Remote(String)
Tuple Fields
0: StringA remote error
+Connection(ConnectionReason)
Error creating a connection, or an error with a connection being closed unexpectedly
+Unexpected(String)
Tuple Fields
0: StringAn unexpected error. In this context “unexpected” means
“unexpected because we check ahead of time”, it used to maintain the type signature of
chains of futures; but it occurring at runtime should be considered a catastrophic
failure.
If any error is propagated this way that needs to be handled, then it should be made into
a proper option.
-Tuple Fields of Unexpected
0: StringTrait Implementations
Formats the value using the given formatter. Read more
+Trait Implementations
The lower-level source of this error, if any. Read more
The type returned in the event of a conversion error.
diff --git a/actix_redis/enum.RespValue.html b/actix_redis/enum.RespValue.html
index 90deb48a9..75988ff9f 100644
--- a/actix_redis/enum.RespValue.html
+++ b/actix_redis/enum.RespValue.html
@@ -1,4 +1,4 @@
-RespValue in actix_redis - Rust Enum actix_redis::RespValue [−]
pub enum RespValue {
+RespValue in actix_redis - Rust Enum actix_redis::RespValue [−]
pub enum RespValue {
Nil,
Array(Vec<RespValue, Global>),
BulkString(Vec<u8, Global>),
@@ -8,27 +8,27 @@
}
Expand description
A single RESP value, this owns the data that is read/to-be written to Redis.
It is cloneable to allow multiple copies to be delivered in certain circumstances, e.g. multiple
subscribers to the same topic.
-Variants
Zero, one or more other RespValues.
-A bulk string. In Redis terminology a string is a byte-array, so this is stored as a
+
Variants
Nil
Array(Vec<RespValue, Global>)
Zero, one or more other RespValues.
+BulkString(Vec<u8, Global>)
A bulk string. In Redis terminology a string is a byte-array, so this is stored as a
vector of u8s to allow clients to interpret the bytes as appropriate.
-Error(String)An error from the Redis server
-Tuple Fields of Error
0: StringInteger(i64)Redis documentation defines an integer as being a signed 64-bit integer:
+
Error(String)
Tuple Fields
0: StringAn error from the Redis server
+Integer(i64)
Tuple Fields
0: i64Redis documentation defines an integer as being a signed 64-bit integer:
https://redis.io/topics/protocol#resp-integers
-Tuple Fields of Integer
0: i64SimpleString(String)Tuple Fields of SimpleString
0: StringImplementations
impl RespValue
pub fn append<T>(self, other: impl IntoIterator<Item = T>) -> RespValue where
T: Into<RespValue>,
Convenience function for building dynamic Redis commands with variable numbers of
+
SimpleString(String)
Tuple Fields
0: StringImplementations
impl RespValue
pub fn append<T>(self, other: impl IntoIterator<Item = T>) -> RespValue where
T: Into<RespValue>,
Convenience function for building dynamic Redis commands with variable numbers of
arguments, e.g. RPUSH
This will panic if called for anything other than arrays
Trait Implementations
This method tests for self and other values to be equal, and is used
diff --git a/actix_redis/enum.SameSite.html b/actix_redis/enum.SameSite.html
index 5453961e7..acd1a578e 100644
--- a/actix_redis/enum.SameSite.html
+++ b/actix_redis/enum.SameSite.html
@@ -1,4 +1,4 @@
-
SameSite in actix_redis - Rust Enum actix_redis::SameSite [−][src]
pub enum SameSite {
+SameSite in actix_redis - Rust Enum actix_redis::SameSite [−][src]
pub enum SameSite {
Strict,
Lax,
None,
@@ -18,9 +18,9 @@ initally or passing None to HTTP draft! Its meaning and
definition are subject to change.
-
Variants
The “Strict” SameSite attribute.
-The “Lax” SameSite attribute.
-The “None” SameSite attribute.
+Variants
Strict
The “Strict” SameSite attribute.
+Lax
The “Lax” SameSite attribute.
+None
The “None” SameSite attribute.
Implementations
Trait Implementations
This method tests for self and other values to be equal, and is used
@@ -69,7 +69,7 @@ by ==.
Creates owned data from borrowed data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (toowned_clone_into)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
-
The type returned in the event of a conversion error.
diff --git a/actix_redis/index.html b/actix_redis/index.html
index f1dc58f69..f4a9eb5c9 100644
--- a/actix_redis/index.html
+++ b/actix_redis/index.html
@@ -1,4 +1,4 @@
-actix_redis - Rust Crate actix_redis[−][src]
Expand description
Redis integration for Actix and session store for Actix Web.
+actix_redis - Rust Crate actix_redis[−][src]
Expand description
Redis integration for Actix and session store for Actix Web.
Structs
Command for send data to Redis
Redis communication actor
diff --git a/actix_redis/struct.Command.html b/actix_redis/struct.Command.html
index 613e35037..21d9591d9 100644
--- a/actix_redis/struct.Command.html
+++ b/actix_redis/struct.Command.html
@@ -1,4 +1,4 @@
-Command in actix_redis - Rust Struct actix_redis::Command [−][src]
pub struct Command(pub RespValue);
Expand description
Command for send data to Redis
+Command in actix_redis - Rust Struct actix_redis::Command [−][src]
pub struct Command(pub RespValue);
Expand description
Command for send data to Redis
Tuple Fields
0: RespValueTrait Implementations
The type of value that this handler will return. Read more
This method is called for every message received by this actor.
diff --git a/actix_redis/struct.RedisActor.html b/actix_redis/struct.RedisActor.html
index f542cef6d..9f3bb95be 100644
--- a/actix_redis/struct.RedisActor.html
+++ b/actix_redis/struct.RedisActor.html
@@ -1,4 +1,4 @@
-RedisActor in actix_redis - Rust Struct actix_redis::RedisActor [−][src]
pub struct RedisActor { /* fields omitted */ }
Expand description
Redis communication actor
+RedisActor in actix_redis - Rust Struct actix_redis::RedisActor [−][src]
pub struct RedisActor { /* fields omitted */ }
Expand description
Redis communication actor
Implementations
Start new Supervisor with RedisActor.
Trait Implementations
type Context = Context<Self>
Actor execution context type
Called when an actor gets polled the first time.
diff --git a/actix_redis/struct.RedisSession.html b/actix_redis/struct.RedisSession.html
index f74ee750b..149141161 100644
--- a/actix_redis/struct.RedisSession.html
+++ b/actix_redis/struct.RedisSession.html
@@ -1,4 +1,4 @@
-RedisSession in actix_redis - Rust Struct actix_redis::RedisSession [−][src]
pub struct RedisSession(_);
Expand description
Use redis as session storage.
+RedisSession in actix_redis - Rust Struct actix_redis::RedisSession [−][src]
pub struct RedisSession(_);
Expand description
Use redis as session storage.
You need to pass an address of the redis server and random value to the
constructor of RedisSession. This is private key for cookie
session, When this value is changed, all session data is lost.
diff --git a/actix_session/all.html b/actix_session/all.html
index 152b0185a..c174940d5 100644
--- a/actix_session/all.html
+++ b/actix_session/all.html
@@ -1,4 +1,4 @@
-List of all items in this crate List of all items[−]
+List of all items in this crate List of all items[−]
Structs
Enums
Traits
SessionStatus in actix_session - Rust Enum actix_session::SessionStatus [−][src]
pub enum SessionStatus {
+SessionStatus in actix_session - Rust Enum actix_session::SessionStatus [−][src]
pub enum SessionStatus {
Changed,
Purged,
Renewed,
Unchanged,
}
Expand description
Status of a Session.
-Variants
Session has been updated and requires a new persist operation.
-Session is flagged for deletion and should be removed from client and server.
+Variants
Changed
Session has been updated and requires a new persist operation.
+Purged
Session is flagged for deletion and should be removed from client and server.
Most operations on the session after purge flag is set should have no effect.
-Session is flagged for refresh.
+Renewed
Session is flagged for refresh.
For example, when using a backend that has a TTL (time-to-live) expiry on the session entry,
the session will be refreshed even if no data inside it has changed. The client may also
be notified of the refresh.
-Session is unchanged from when last seen (if exists).
+Unchanged
Session is unchanged from when last seen (if exists).
This state also captures new (previously unissued) sessions such as a user’s first
site visit.
Trait Implementations
Returns the “default value” for a type. Read more
This method tests for self and other values to be equal, and is used
diff --git a/actix_session/index.html b/actix_session/index.html
index 9fefb93fa..b84ce77f5 100644
--- a/actix_session/index.html
+++ b/actix_session/index.html
@@ -1,4 +1,4 @@
-
actix_session - Rust Crate actix_session[−][src]
Expand description
Sessions for Actix Web.
+actix_session - Rust Crate actix_session[−][src]
Expand description
Sessions for Actix Web.
Provides a general solution for session management. Session middleware could provide different
implementations which could be accessed via general session API.
This crate provides a general solution for session management and includes a cookie backend.
diff --git a/actix_session/struct.CookieSession.html b/actix_session/struct.CookieSession.html
index 138ddba33..6b84685ac 100644
--- a/actix_session/struct.CookieSession.html
+++ b/actix_session/struct.CookieSession.html
@@ -1,4 +1,4 @@
-
CookieSession in actix_session - Rust Struct actix_session::CookieSession [−][src]
pub struct CookieSession(_);
Expand description
Use cookies for session storage.
+CookieSession in actix_session - Rust Struct actix_session::CookieSession [−][src]
pub struct CookieSession(_);
Expand description
Use cookies for session storage.
CookieSession creates sessions which are limited to storing
fewer than 4000 bytes of data (as the payload must fit into a single
cookie). An Internal Server Error is generated if the session contains more
@@ -48,14 +48,14 @@ connection is secure - i.e. https
Sets the expires field in the session cookie being built.
Sets the expires field in the session cookie being built.
Trait Implementations
impl<S, B> Transform<S, ServiceRequest> for CookieSession where
S: Service<ServiceRequest, Response = ServiceResponse<B>>,
S::Future: 'static,
S::Error: 'static,
B: MessageBody + 'static,
B::Error: StdError,
Auto Trait Implementations
impl !RefUnwindSafe for CookieSession
impl !Send for CookieSession
impl !Sync for CookieSession
impl Unpin for CookieSession
impl UnwindSafe for CookieSession
Blanket Implementations
Auto Trait Implementations
impl RefUnwindSafe for CookieSession
impl !Send for CookieSession
impl !Sync for CookieSession
impl Unpin for CookieSession
impl UnwindSafe for CookieSession
Blanket Implementations
Mutably borrows from an owned value. Read more
Performs the conversion.
diff --git a/actix_session/struct.Session.html b/actix_session/struct.Session.html
index 3ebb2ae6e..7672f81d5 100644
--- a/actix_session/struct.Session.html
+++ b/actix_session/struct.Session.html
@@ -1,4 +1,4 @@
-Session in actix_session - Rust Struct actix_session::Session [−][src]
pub struct Session(_);
Expand description
The high-level interface you use to modify session data.
+Session in actix_session - Rust Struct actix_session::Session [−][src]
pub struct Session(_);
Expand description
The high-level interface you use to modify session data.
Session object is obtained with UserSession::get_session. The UserSession trait is
implemented for HttpRequest, ServiceRequest, and RequestHead.
@@ -36,12 +36,12 @@ already be JSON serialized.
let mut req = test::TestRequest::default().to_srv_request();
Session::set_session(
- &mut req,
+ &mut req,
vec![("counter".to_string(), serde_json::to_string(&0).unwrap())],
);
pub fn get_changes<B>(
res: &mut ServiceResponse<B>
) -> (SessionStatus, impl Iterator<Item = (String, String)>)
Returns session status and iterator of key-value pairs of changes.
Trait Implementations
Extractor implementation for Session type.
-Examples
+Examples
use actix_session::Session;
#[get("/")]
diff --git a/actix_session/trait.UserSession.html b/actix_session/trait.UserSession.html
index 7cc14115e..1ad06ebb8 100644
--- a/actix_session/trait.UserSession.html
+++ b/actix_session/trait.UserSession.html
@@ -1,4 +1,4 @@
-UserSession in actix_session - Rust Trait actix_session::UserSession [−][src]
pub trait UserSession {
+UserSession in actix_session - Rust Trait actix_session::UserSession [−][src]
pub trait UserSession {
fn get_session(&self) -> Session;
}
Expand description
Extraction of a Session object.
Required methods
fn get_session(&self) -> Session
Extract the Session object
diff --git a/actix_web_httpauth/all.html b/actix_web_httpauth/all.html
index f35234b99..3f16567c3 100644
--- a/actix_web_httpauth/all.html
+++ b/actix_web_httpauth/all.html
@@ -1,4 +1,4 @@
-List of all items in this crate List of all items[−]
+List of all items in this crate