#[non_exhaustive]pub enum CorsError {
+CorsError in actix_cors - Rust Enum actix_cors::CorsError
source · #[non_exhaustive]pub enum CorsError {
WildcardOrigin,
MissingOrigin,
MissingRequestMethod,
@@ -34,4 +34,5 @@
V: MultiLane<T>,
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreCross-Origin Resource Sharing (CORS) controls for Actix Web.
+Cross-Origin Resource Sharing (CORS) controls for Actix Web.
This middleware can be applied to both applications and resources. Once built, a Cors
builder can be used as an argument for Actix Web’s App::wrap(), Scope::wrap(), or
Resource::wrap() methods.
pub struct Cors { /* private fields */ }Builder for CORS middleware.
+pub struct Cors { /* private fields */ }Builder for CORS middleware.
To construct a CORS middleware, call Cors::default() to create a blank, restrictive builder.
Then use any of the builder methods to customize CORS behavior.
The alternative Cors::permissive() constructor is available for local development, allowing
@@ -147,4 +147,5 @@ not supported. No max age (will use browser’s default).
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more#[non_exhaustive]pub enum LogoutBehaviour {
+LogoutBehaviour in actix_identity::config - Rust Enum actix_identity::config::LogoutBehaviour
source · #[non_exhaustive]pub enum LogoutBehaviour {
PurgeSession,
DeleteIdentityKeys,
}
Expand description
LogoutBehaviour controls what actions are going to be performed when Identity::logout is
@@ -27,4 +27,5 @@ is not tied to the user’s identity and should be retained after logout.
V: MultiLane<T>,§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreConfiguration options to tune the behaviour of IdentityMiddleware.
Configuration options to tune the behaviour of IdentityMiddleware.
IdentityMiddleware instance with custom configuration
parameters.LogoutBehaviour controls what actions are going to be performed when Identity::logout is
invoked.pub struct IdentityMiddlewareBuilder { /* private fields */ }A fluent builder to construct an IdentityMiddleware instance with custom configuration
+
pub struct IdentityMiddlewareBuilder { /* private fields */ }A fluent builder to construct an IdentityMiddleware instance with custom configuration
parameters.
Use IdentityMiddleware::builder to get started!
Set a custom key to identify the user in the session.
@@ -42,4 +42,5 @@ has passed since their last visit. V: MultiLane<T>,Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more#[non_exhaustive]pub enum GetIdentityError {
+GetIdentityError in actix_identity::error - Rust Enum actix_identity::error::GetIdentityError
source · #[non_exhaustive]pub enum GetIdentityError {
SessionExpiryError(SessionExpiryError),
MissingIdentityError(MissingIdentityError),
- SessionGetError(SessionGetError),
+ SessionGetError(SessionGetError),
LostIdentityError(LostIdentityError),
}
Expand description
Errors that can occur while retrieving an identity.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.§SessionExpiryError(SessionExpiryError)
The session has expired.
§MissingIdentityError(MissingIdentityError)
No identity is found in a session.
-§SessionGetError(SessionGetError)
Failed to accessing the session store.
+§SessionGetError(SessionGetError)
Failed to accessing the session store.
§LostIdentityError(LostIdentityError)
Identity info was lost after being validated.
Seeing this error indicates a bug in actix-identity.
-Trait Implementations§
source§impl Debug for GetIdentityError
source§impl Display for GetIdentityError
source§impl Error for GetIdentityError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<LostIdentityError> for GetIdentityError
source§fn from(original: LostIdentityError) -> GetIdentityError
Converts to this type from the input type.source§impl From<MissingIdentityError> for GetIdentityError
source§fn from(original: MissingIdentityError) -> GetIdentityError
Converts to this type from the input type.source§impl From<SessionExpiryError> for GetIdentityError
source§fn from(original: SessionExpiryError) -> GetIdentityError
Converts to this type from the input type.source§impl From<SessionGetError> for GetIdentityError
source§fn from(original: SessionGetError) -> GetIdentityError
Converts to this type from the input type.source§impl ResponseError for GetIdentityError
source§fn status_code(&self) -> StatusCode
Returns appropriate status code for error. Read more§fn error_response(&self) -> HttpResponse
Creates full response for error. Read moreAuto Trait Implementations§
§impl Freeze for GetIdentityError
§impl RefUnwindSafe for GetIdentityError
§impl Send for GetIdentityError
§impl Sync for GetIdentityError
§impl Unpin for GetIdentityError
§impl UnwindSafe for GetIdentityError
Blanket Implementations§
Trait Implementations§
source§impl Debug for GetIdentityError
source§impl Display for GetIdentityError
source§impl Error for GetIdentityError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<LostIdentityError> for GetIdentityError
source§fn from(original: LostIdentityError) -> GetIdentityError
Converts to this type from the input type.source§impl From<MissingIdentityError> for GetIdentityError
source§fn from(original: MissingIdentityError) -> GetIdentityError
Converts to this type from the input type.source§impl From<SessionExpiryError> for GetIdentityError
source§fn from(original: SessionExpiryError) -> GetIdentityError
Converts to this type from the input type.source§impl From<SessionGetError> for GetIdentityError
source§fn from(original: SessionGetError) -> GetIdentityError
Converts to this type from the input type.source§impl ResponseError for GetIdentityError
source§fn status_code(&self) -> StatusCode
Returns appropriate status code for error. Read more§fn error_response(&self) -> HttpResponse
Creates full response for error. Read moreAuto Trait Implementations§
§impl Freeze for GetIdentityError
§impl RefUnwindSafe for GetIdentityError
§impl Send for GetIdentityError
§impl Sync for GetIdentityError
§impl Unpin for GetIdentityError
§impl UnwindSafe for GetIdentityError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more
\ No newline at end of file
+[WithDispatch] wrapper. Read moreFailure modes of identity operations.
+Failure modes of identity operations.
pub struct LoginError(/* private fields */);Error that can occur during login attempts.
-pub struct LoginError(/* private fields */);Error that can occur during login attempts.
+Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more#[non_exhaustive]pub struct LostIdentityError;The identity information has been lost.
+#[non_exhaustive]pub struct LostIdentityError;The identity information has been lost.
Seeing this error in user code indicates a bug in actix-identity.
-Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more#[non_exhaustive]pub struct MissingIdentityError;There is no identity information attached to the current session.
-#[non_exhaustive]pub struct MissingIdentityError;There is no identity information attached to the current session.
+Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct SessionExpiryError(/* private fields */);Error encountered when working with a session that has expired.
-pub struct SessionExpiryError(/* private fields */);Error encountered when working with a session that has expired.
+Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreIdentity management for Actix Web.
+Identity management for Actix Web.
actix-identity can be used to track identity of a user across multiple requests. It is built
on top of HTTP sessions, via actix-session.
pub struct Identity(/* private fields */);A verified user identity. It can be used as a request extractor.
+pub struct Identity(/* private fields */);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.
@@ -117,4 +117,5 @@ require a validSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct IdentityMiddleware { /* private fields */ }Identity management middleware.
+pub struct IdentityMiddleware { /* private fields */ }Identity management middleware.
use actix_web::{cookie::Key, App, HttpServer};
use actix_session::storage::RedisSessionStore;
@@ -40,4 +40,5 @@
V: MultiLane<T>,Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub trait IdentityExt {
+IdentityExt in actix_identity - Rust Trait actix_identity::IdentityExt
source · pub trait IdentityExt {
// Required method
fn get_identity(&self) -> Result<Identity, GetIdentityError>;
}
Expand description
Helper trait to retrieve an Identity instance from various actix-web’s types.
diff --git a/actix_limitation/all.html b/actix_limitation/all.html
index 3c88e52dc..5c23e2a07 100644
--- a/actix_limitation/all.html
+++ b/actix_limitation/all.html
@@ -1 +1 @@
-List of all items in this crate List of all items
Structs
Enums
Constants
List of all items in this crate List of all items
Structs
Enums
Constants
DEFAULT_COOKIE_NAME in actix_limitation - Rust Constant actix_limitation::DEFAULT_COOKIE_NAME
source · pub const DEFAULT_COOKIE_NAME: &str = "sid";
Expand description
Default cookie name.
+DEFAULT_COOKIE_NAME in actix_limitation - Rust Constant actix_limitation::DEFAULT_COOKIE_NAME
source · pub const DEFAULT_COOKIE_NAME: &str = "sid";
Expand description
Default cookie name.
DEFAULT_PERIOD_SECS in actix_limitation - Rust Constant actix_limitation::DEFAULT_PERIOD_SECS
source · pub const DEFAULT_PERIOD_SECS: u64 = 3600;
Expand description
Default period (in seconds).
+DEFAULT_PERIOD_SECS in actix_limitation - Rust Constant actix_limitation::DEFAULT_PERIOD_SECS
source · pub const DEFAULT_PERIOD_SECS: u64 = 3600;
Expand description
Default period (in seconds).
DEFAULT_REQUEST_LIMIT in actix_limitation - Rust Constant actix_limitation::DEFAULT_REQUEST_LIMIT
source · pub const DEFAULT_REQUEST_LIMIT: usize = 5000;
Expand description
Default request limit.
+DEFAULT_REQUEST_LIMIT in actix_limitation - Rust Constant actix_limitation::DEFAULT_REQUEST_LIMIT
source · pub const DEFAULT_REQUEST_LIMIT: usize = 5000;
Expand description
Default request limit.
DEFAULT_SESSION_KEY in actix_limitation - Rust Constant actix_limitation::DEFAULT_SESSION_KEY
source · pub const DEFAULT_SESSION_KEY: &str = "rate-api-id";
Expand description
Default session key.
+DEFAULT_SESSION_KEY in actix_limitation - Rust Constant actix_limitation::DEFAULT_SESSION_KEY
source · pub const DEFAULT_SESSION_KEY: &str = "rate-api-id";
Expand description
Default session key.
Error in actix_limitation - Rust Enum actix_limitation::Error
source · pub enum Error {
+Error in actix_limitation - Rust Enum actix_limitation::Error
source · pub enum Error {
Client(RedisError),
LimitExceeded(Status),
Time(ComponentRange),
@@ -25,4 +25,5 @@
V: MultiLane<T>,
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
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 279a91be4..4e684ccaa 100644
--- a/actix_limitation/struct.Builder.html
+++ b/actix_limitation/struct.Builder.html
@@ -1,4 +1,4 @@
-Builder in actix_limitation - Rust Struct actix_limitation::Builder
source · pub struct Builder { /* private fields */ }
Expand description
Rate limiter builder.
+Builder in actix_limitation - Rust Struct actix_limitation::Builder
source · pub struct Builder { /* private fields */ }
Expand description
Rate limiter builder.
Implementations§
source§impl Builder
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more
\ No newline at end of file
+[WithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
\ No newline at end of file
diff --git a/actix_limitation/struct.Limiter.html b/actix_limitation/struct.Limiter.html
index 36fbdfb97..560a65f61 100644
--- a/actix_limitation/struct.Limiter.html
+++ b/actix_limitation/struct.Limiter.html
@@ -1,4 +1,4 @@
-Limiter in actix_limitation - Rust Struct actix_limitation::Limiter
source · pub struct Limiter { /* private fields */ }
Expand description
Rate limiter.
+Limiter in actix_limitation - Rust Struct actix_limitation::Limiter
source · pub struct Limiter { /* private fields */ }
Expand description
Rate limiter.
Implementations§
source§impl Limiter
sourcepub fn builder(redis_url: impl Into<String>) -> Builder
Construct rate limiter builder with defaults.
See redis-rs docs on connection
parameters for how to set the Redis URL.
@@ -20,4 +20,5 @@ parameters for how to set the Redis URL.
V: MultiLane<T>,§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more
\ No newline at end of file
+[WithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
RateLimiter in actix_limitation - Rust Struct actix_limitation::RateLimiter
source · #[non_exhaustive]pub struct RateLimiter;
Expand description
Rate limit middleware.
+RateLimiter in actix_limitation - Rust Struct actix_limitation::RateLimiter
source · #[non_exhaustive]pub struct RateLimiter;
Expand description
Rate limit middleware.
Trait Implementations§
source§impl Debug for RateLimiter
source§impl Default for RateLimiter
source§fn default() -> RateLimiter
Returns the “default value” for a type. Read moresource§impl<S, B> Transform<S, ServiceRequest> for RateLimiterwhere
S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
S::Future: 'static,
@@ -18,4 +18,5 @@
V: MultiLane<T>,
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
Status in actix_limitation - Rust Struct actix_limitation::Status
source · pub struct Status { /* private fields */ }
Expand description
A report for a given key containing the limit status.
+Status in actix_limitation - Rust Struct actix_limitation::Status
source · pub struct Status { /* private fields */ }
Expand description
A report for a given key containing the limit status.
Implementations§
source§impl Status
sourcepub fn limit(&self) -> usize
Returns the maximum number of requests allowed in the current period.
sourcepub fn reset_epoch_utc(&self) -> usize
Returns a UNIX timestamp in UTC approximately when the next period will begin.
@@ -19,4 +19,5 @@
V: MultiLane<T>,§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more
\ No newline at end of file
+[WithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
List of all items in this crate List of all items
Structs
Enums
Traits
List of all items in this crate List of all items
Structs
Enums
Traits
ProtoBufPayloadError in actix_protobuf - Rust pub enum ProtoBufPayloadError {
+ProtoBufPayloadError in actix_protobuf - Rust pub enum ProtoBufPayloadError {
Overflow,
ContentType,
Serialize(EncodeError),
@@ -26,4 +26,5 @@
V: MultiLane<T>,
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
actix_protobuf - Rust Crate actix_protobuf
source · Expand description
Protobuf payload extractor for Actix Web.
+actix_protobuf - Rust Crate actix_protobuf
source · Expand description
Protobuf payload extractor for Actix Web.
Structs§
Enums§
Traits§
ProtoBuf in actix_protobuf - Rust Struct actix_protobuf::ProtoBuf
source · pub struct ProtoBuf<T: Message>(pub T);
Tuple Fields§
§0: TTrait Implementations§
source§impl<T> FromRequest for ProtoBuf<T>where
+ProtoBuf in actix_protobuf - Rust Struct actix_protobuf::ProtoBuf
source · pub struct ProtoBuf<T: Message>(pub T);
Tuple Fields§
§0: TTrait Implementations§
Auto Trait Implementations§
§impl<T> Freeze for ProtoBuf<T>where
T: Freeze,
§impl<T> RefUnwindSafe for ProtoBuf<T>where
@@ -23,8 +23,9 @@
V: MultiLane<T>,
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more§impl<T> Formattable for Twhere
+[WithDispatch] wrapper. Read more
§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> Formattable for T
§impl<T> Parsable for T
§impl<T> MaybeSendSync for T
§impl<T> Parsable for T
ProtoBufConfig in actix_protobuf - Rust Struct actix_protobuf::ProtoBufConfig
source · pub struct ProtoBufConfig { /* private fields */ }
Implementations§
source§impl ProtoBufConfig
sourcepub fn limit(&mut self, limit: usize) -> &mut Self
Change max size of payload. By default max size is 256Kb
+ProtoBufConfig in actix_protobuf - Rust Struct actix_protobuf::ProtoBufConfig
source · pub struct ProtoBufConfig { /* private fields */ }
Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for ProtoBufConfig
§impl RefUnwindSafe for ProtoBufConfig
§impl Send for ProtoBufConfig
§impl Sync for ProtoBufConfig
§impl Unpin for ProtoBufConfig
§impl UnwindSafe for ProtoBufConfig
Blanket Implementations§
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
ProtoBufMessage in actix_protobuf - Rust Struct actix_protobuf::ProtoBufMessage
source · pub struct ProtoBufMessage<T: Message + Default> { /* private fields */ }
Implementations§
source§impl<T: Message + Default> ProtoBufMessage<T>
sourcepub fn new(req: &HttpRequest, payload: &mut Payload) -> Self
Create ProtoBufMessage for request.
+ProtoBufMessage in actix_protobuf - Rust Struct actix_protobuf::ProtoBufMessage
source · pub struct ProtoBufMessage<T: Message + Default> { /* private fields */ }
Implementations§
Trait Implementations§
source§impl<T: Message + Default + 'static> Future for ProtoBufMessage<T>
§type Output = Result<T, ProtoBufPayloadError>
The type of value produced on completion.Auto Trait Implementations§
§impl<T> Freeze for ProtoBufMessage<T>
§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§
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more
§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
ProtoBufResponseBuilder in actix_protobuf - Rust pub trait ProtoBufResponseBuilder {
+ProtoBufResponseBuilder in actix_protobuf - Rust List of all items in this crate List of all items
Structs
- Session
- SessionGetError
- SessionInsertError
- SessionMiddleware
- config::BrowserSession
- config::PersistentSession
- config::SessionMiddlewareBuilder
- storage::CookieSessionStore
- storage::RedisSessionStore
- storage::RedisSessionStoreBuilder
- storage::SessionKey
Enums
- SessionStatus
- config::CookieContentSecurity
- config::SessionLifecycle
- config::TtlExtensionPolicy
- storage::LoadError
- storage::SaveError
- storage::UpdateError
Traits
List of all items in this crate List of all items
Structs
- Session
- SessionGetError
- SessionInsertError
- SessionMiddleware
- config::BrowserSession
- config::PersistentSession
- config::SessionMiddlewareBuilder
- storage::CookieSessionStore
- storage::RedisSessionStore
- storage::RedisSessionStoreBuilder
- storage::SessionKey
Enums
- SessionStatus
- config::CookieContentSecurity
- config::SessionLifecycle
- config::TtlExtensionPolicy
- storage::LoadError
- storage::SaveError
- storage::UpdateError
Traits
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.
@@ -26,4 +26,5 @@ tamper with the cookie content, but they can read it.
V: MultiLane<T>,§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more
WithDispatch] wrapper. Read more
§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
#[non_exhaustive]pub enum SessionLifecycle {
+SessionLifecycle in actix_session::config - Rust Enum actix_session::config::SessionLifecycle
source · #[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.
@@ -11,7 +11,7 @@ Check the documentation of the browsers you are targeting for up-to-date informa
§PersistentSession(PersistentSession)
The session cookie will be a persistent cookie.
Persistent cookies have a pre-determined lifetime, specified via the Max-Age or Expires
attribute. They do not disappear when the current browser session ends.
-Trait Implementations§
source§impl Clone for SessionLifecycle
source§fn clone(&self) -> SessionLifecycle
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SessionLifecycle
source§impl From<BrowserSession> for SessionLifecycle
source§fn from(original: BrowserSession) -> SessionLifecycle
Converts to this type from the input type.source§impl From<PersistentSession> for SessionLifecycle
source§fn from(original: PersistentSession) -> SessionLifecycle
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for SessionLifecycle
§impl RefUnwindSafe for SessionLifecycle
§impl Send for SessionLifecycle
§impl Sync for SessionLifecycle
§impl Unpin for SessionLifecycle
§impl UnwindSafe for SessionLifecycle
Blanket Implementations§
Trait Implementations§
source§impl Clone for SessionLifecycle
source§fn clone(&self) -> SessionLifecycle
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SessionLifecycle
source§impl From<BrowserSession> for SessionLifecycle
source§fn from(original: BrowserSession) -> SessionLifecycle
Converts to this type from the input type.source§impl From<PersistentSession> for SessionLifecycle
source§fn from(original: PersistentSession) -> SessionLifecycle
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for SessionLifecycle
§impl RefUnwindSafe for SessionLifecycle
§impl Send for SessionLifecycle
§impl Sync for SessionLifecycle
§impl Unpin for SessionLifecycle
§impl UnwindSafe for SessionLifecycle
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
@@ -28,4 +28,5 @@ attribute. They do not disappear when the current browser session ends.
V: MultiLane<T>,§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more#[non_exhaustive]pub enum TtlExtensionPolicy {
+TtlExtensionPolicy in actix_session::config - Rust Enum actix_session::config::TtlExtensionPolicy
source · #[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.
@@ -32,4 +32,5 @@ your server.
V: MultiLane<T>,§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreConfiguration options to tune the behaviour of SessionMiddleware.
Configuration options to tune the behaviour of SessionMiddleware.
SessionMiddleware builder.pub struct BrowserSession { /* private fields */ }A session lifecycle strategy where the session cookie expires when the +
pub struct BrowserSession { /* private fields */ }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 @@ -45,4 +45,5 @@ specifying a more aggressive state TTL extension policy - check out V: MultiLane<T>,
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct PersistentSession { /* private fields */ }A session lifecycle strategy where the session cookie will be persistent.
+pub struct PersistentSession { /* private fields */ }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
@@ -45,4 +45,5 @@ See fn vzip(self) -> V
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct SessionMiddlewareBuilder<Store: SessionStore> { /* private fields */ }A fluent, customized SessionMiddleware builder.
pub struct SessionMiddlewareBuilder<Store: SessionStore> { /* private fields */ }A fluent, customized SessionMiddleware builder.
Set the name of the cookie used to store the session ID.
Defaults to id.
Set the Secure attribute for the cookie used to store the session ID.
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub enum SessionStatus {
+SessionStatus in actix_session - Rust Enum actix_session::SessionStatus
source · pub enum SessionStatus {
Changed,
Purged,
Renewed,
@@ -31,4 +31,5 @@ sufficient, and should not be overridden without very good reason.
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreSession management for Actix Web.
+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 33c9a1773..b2beb133f 100644 --- a/actix_session/storage/enum.LoadError.html +++ b/actix_session/storage/enum.LoadError.html @@ -1,10 +1,10 @@ -
pub enum LoadError {
+LoadError in actix_session::storage - Rust Enum actix_session::storage::LoadError
source · 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 Error for LoadError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for LoadError
§impl RefUnwindSafe for LoadError
§impl Send for LoadError
§impl Sync for LoadError
§impl Unpin for LoadError
§impl UnwindSafe for LoadError
Blanket Implementations§
Trait Implementations§
source§impl Error for LoadError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for LoadError
§impl RefUnwindSafe for LoadError
§impl Send for LoadError
§impl Sync for LoadError
§impl Unpin for LoadError
§impl UnwindSafe for LoadError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more
\ No newline at end of file
+[WithDispatch] wrapper. Read morepub enum SaveError {
+SaveError in actix_session::storage - Rust Enum actix_session::storage::SaveError
source · pub enum SaveError {
Serialization(Error),
Other(Error),
}
Expand description
Possible failures modes for SessionStore::save.
Variants§
§Serialization(Error)
Failed to serialize session state.
§Other(Error)
Something went wrong when persisting the session state.
-Trait Implementations§
source§impl Error for SaveError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SaveError
§impl RefUnwindSafe for SaveError
§impl Send for SaveError
§impl Sync for SaveError
§impl Unpin for SaveError
§impl UnwindSafe for SaveError
Blanket Implementations§
Trait Implementations§
source§impl Error for SaveError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SaveError
§impl RefUnwindSafe for SaveError
§impl Send for SaveError
§impl Sync for SaveError
§impl Unpin for SaveError
§impl UnwindSafe for SaveError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more
\ No newline at end of file
+[WithDispatch] wrapper. Read morepub enum UpdateError {
+UpdateError in actix_session::storage - Rust Enum actix_session::storage::UpdateError
source · 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§impl Display for UpdateError
source§impl Error for UpdateError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for UpdateError
§impl RefUnwindSafe for UpdateError
§impl Send for UpdateError
§impl Sync for UpdateError
§impl Unpin for UpdateError
§impl UnwindSafe for UpdateError
Blanket Implementations§
Trait Implementations§
source§impl Debug for UpdateError
source§impl Display for UpdateError
source§impl Error for UpdateError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for UpdateError
§impl RefUnwindSafe for UpdateError
§impl Send for UpdateError
§impl Sync for UpdateError
§impl Unpin for UpdateError
§impl UnwindSafe for UpdateError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more
\ No newline at end of file
+[WithDispatch] wrapper. Read morePluggable storage backends for session state.
+Pluggable storage backends for session state.
RedisSessionStore instance with custom configuration
parameters.SessionStore::load.SessionStore::save.SessionStore::update.#[non_exhaustive]pub struct CookieSessionStore;Use the session key, stored in the session cookie, as storage backend for the session state.
+#[non_exhaustive]pub struct CookieSessionStore;Use the session key, stored in the session cookie, as storage backend for the session state.
use actix_web::{cookie::Key, web, App, HttpServer, HttpResponse, Error};
use actix_session::{SessionMiddleware, storage::CookieSessionStore};
@@ -60,4 +60,5 @@ storage backend.
V: MultiLane<T>,Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct RedisSessionStore { /* private fields */ }Use Redis as session storage backend.
+pub struct RedisSessionStore { /* private fields */ }Use Redis as session storage backend.
use actix_web::{web, App, HttpServer, HttpResponse, Error};
use actix_session::{SessionMiddleware, storage::RedisSessionStore};
@@ -79,4 +79,5 @@ connection string for Redis.
V: MultiLane<T>,Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct RedisSessionStoreBuilder { /* private fields */ }A fluent builder to construct a RedisSessionStore instance with custom configuration
+
pub struct RedisSessionStoreBuilder { /* private fields */ }A fluent builder to construct a RedisSessionStore instance with custom configuration
parameters.
Set a custom cache key generation strategy, expecting a session key as input.
@@ -19,4 +19,5 @@ parameters. V: MultiLane<T>,Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct SessionKey(/* private fields */);A session key, the string stored in a client-side cookie to associate a user with its session +
pub struct SessionKey(/* private fields */);A session key, the string stored in a client-side cookie to associate a user with its session state on the backend.
Session keys are stored as cookies, therefore they cannot be arbitrary long. Session keys are @@ -27,4 +27,5 @@ sufficient, and should not be overridden without very good reason.
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub trait SessionStore {
+SessionStore in actix_session::storage - Rust Trait actix_session::storage::SessionStore
source · pub trait SessionStore {
// Required methods
fn load(
&self,
diff --git a/actix_session/struct.Session.html b/actix_session/struct.Session.html
index 890217ca0..897a40cae 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
source · pub struct Session(/* private fields */);
Expand description
The primary interface to access and modify session state.
+Session in actix_session - Rust Struct actix_session::Session
source · pub struct Session(/* private fields */);
Expand description
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more
§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
pub struct SessionGetError(/* private fields */);Error returned by Session::get.
pub struct SessionGetError(/* private fields */);Error returned by Session::get.
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct SessionInsertError(/* private fields */);Error returned by Session::insert.
pub struct SessionInsertError(/* private fields */);Error returned by Session::insert.
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct SessionMiddleware<Store: SessionStore> { /* private fields */ }A middleware for session management in Actix Web applications.
+pub struct SessionMiddleware<Store: SessionStore> { /* private fields */ }A middleware for session management in Actix Web applications.
SessionMiddleware takes care of a few jobs:
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub trait SessionExt {
+SessionExt in actix_session - Rust Trait actix_session::SessionExt
source · pub trait SessionExt {
// Required method
fn get_session(&self) -> Session;
}
Expand description
Extract a Session object from various actix-web types (e.g. HttpRequest,
diff --git a/actix_settings/all.html b/actix_settings/all.html
index 9b1d25e76..1dfb9886f 100644
--- a/actix_settings/all.html
+++ b/actix_settings/all.html
@@ -1 +1 @@
-
List of all items in this crate List of all items
Structs
Enums
Traits
Type Aliases
List of all items in this crate List of all items
Structs
Enums
Traits
Type Aliases
Backlog in actix_settings - Rust Enum actix_settings::Backlog
source · pub enum Backlog {
+Backlog in actix_settings - Rust Enum actix_settings::Backlog
source · pub enum Backlog {
Default,
Manual(usize),
}
Expand description
The maximum number of pending connections.
@@ -36,4 +36,5 @@ sufficient, and should not be overridden without very good reason.Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
source§impl<T> DeserializeOwned for Twhere
- T: for<'de> Deserialize<'de>,
pub enum Error {
+Error in actix_settings - Rust Enum actix_settings::Error
source · pub enum Error {
EnvVarError(VarError),
FileExists(PathBuf),
InvalidValue {
@@ -22,7 +22,7 @@
§ParseIntError(ParseIntError)
Value is not an integer.
§ParseAddressError(String)
Value is not an address.
§TomlError(Error)
Error deserializing as TOML.
-Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub enum KeepAlive {
+KeepAlive in actix_settings - Rust Enum actix_settings::KeepAlive
source · pub enum KeepAlive {
Default,
Disabled,
Os,
@@ -38,4 +38,5 @@ sufficient, and should not be overridden without very good reason.
pub enum MaxConnectionRate {
+MaxConnectionRate in actix_settings - Rust pub enum MaxConnectionRate {
Default,
Manual(usize),
}
Expand description
The maximum per-worker concurrent TLS connection limit.
@@ -34,4 +34,5 @@ sufficient, and should not be overridden without very good reason.Into<Dispatch>,pub enum MaxConnections {
+MaxConnections in actix_settings - Rust Enum actix_settings::MaxConnections
source · pub enum MaxConnections {
Default,
Manual(usize),
}
Expand description
The maximum per-worker number of concurrent connections.
@@ -34,4 +34,5 @@ sufficient, and should not be overridden without very good reason.Into<Dispatch>,pub enum Mode {
+Mode in actix_settings - Rust Enum actix_settings::Mode
source · pub enum Mode {
Development,
Production,
}
Expand description
Marker of intended deployment environment.
@@ -31,4 +31,5 @@ sufficient, and should not be overridden without very good reason.Into<Dispatch>,pub enum NumWorkers {
+NumWorkers in actix_settings - Rust Enum actix_settings::NumWorkers
source · pub enum NumWorkers {
Default,
Manual(usize),
}
Expand description
The number of workers that the server should start.
@@ -33,4 +33,5 @@ sufficient, and should not be overridden without very good reason.Into<Dispatch>,pub enum Timeout {
+Timeout in actix_settings - Rust Enum actix_settings::Timeout
source · pub enum Timeout {
Default,
Milliseconds(usize),
Seconds(usize),
@@ -33,4 +33,5 @@ sufficient, and should not be overridden without very good reason.
Easily manage Actix Web’s settings from a TOML file and environment variables.
+Easily manage Actix Web’s settings from a TOML file and environment variables.
To get started add a Settings::parse_toml("./Server.toml") call to the
top of your main function. This will create a template file with descriptions of all the
configurable settings. You can change or remove anything in that file and it will be picked up
diff --git a/actix_settings/struct.ActixSettings.html b/actix_settings/struct.ActixSettings.html
index bc1bc32d3..1462dd987 100644
--- a/actix_settings/struct.ActixSettings.html
+++ b/actix_settings/struct.ActixSettings.html
@@ -1,4 +1,4 @@
-
pub struct ActixSettings {Show 13 fields
+ActixSettings in actix_settings - Rust Struct actix_settings::ActixSettings
source · pub struct ActixSettings {
pub struct Address {
+Address in actix_settings - Rust Struct actix_settings::Address
source · pub struct Address {
pub host: String,
pub port: u16,
}
Expand description
A host/port pair for the server to bind to.
@@ -31,4 +31,5 @@ sufficient, and should not be overridden without very good reason.Into<Dispatch>,pub struct BasicSettings<A> {
+BasicSettings in actix_settings - Rust Struct actix_settings::BasicSettings
source · pub struct BasicSettings<A> {
pub actix: ActixSettings,
pub application: A,
}
Expand description
Wrapper for server and application-specific settings.
@@ -86,4 +86,5 @@ sufficient, and should not be overridden without very good reason.Into<Dispatch>,#[non_exhaustive]pub struct NoSettings {}Marker type representing no defined application-specific settings.
+#[non_exhaustive]pub struct NoSettings {}Marker type representing no defined application-specific settings.
source. Read morepub struct Tls {
+Tls in actix_settings - Rust Into<Dispatch>, pub trait ApplySettings<S> {
+ApplySettings in actix_settings - Rust Trait actix_settings::ApplySettings
source · pub trait ApplySettings<S> {
// Required method
fn apply_settings(self, settings: &S) -> Self;
}
Expand description
Extension trait for applying parsed settings to the server object.
diff --git a/actix_settings/trait.Parse.html b/actix_settings/trait.Parse.html
index 582ee61af..a437c4ca8 100644
--- a/actix_settings/trait.Parse.html
+++ b/actix_settings/trait.Parse.html
@@ -1,6 +1,6 @@
-Parse in actix_settings - Rust Trait actix_settings::Parse
source · pub trait Parse: Sized {
+Parse in actix_settings - Rust Trait actix_settings::Parse
source · pub trait Parse: Sized {
// Required method
fn parse(string: &str) -> Result<Self, Error>;
}
Expand description
A specialized FromStr trait that returns Error errors
Required Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
Implementors§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
Implementors§
Settings in actix_settings - Rust Type Alias actix_settings::Settings
source · pub type Settings = BasicSettings<NoSettings>;
Expand description
Convenience type alias for BasicSettings with no defined application-specific settings.
+Settings in actix_settings - Rust Type Alias actix_settings::Settings
source · pub type Settings = BasicSettings<NoSettings>;
Expand description
Convenience type alias for BasicSettings with no defined application-specific settings.
Aliased Type§
struct Settings {
pub actix: ActixSettings,
pub application: NoSettings,
diff --git a/actix_web_httpauth/all.html b/actix_web_httpauth/all.html
index a00e8b3af..cb4a589c0 100644
--- a/actix_web_httpauth/all.html
+++ b/actix_web_httpauth/all.html
@@ -1 +1 @@
-List of all items in this crate List of all items
Structs
- extractors::AuthenticationError
- extractors::basic::BasicAuth
- extractors::basic::Config
- extractors::bearer::BearerAuth
- extractors::bearer::Config
- headers::authorization::Authorization
- headers::authorization::Basic
- headers::authorization::Bearer
- headers::www_authenticate::WwwAuthenticate
- headers::www_authenticate::basic::Basic
- headers::www_authenticate::bearer::Bearer
- headers::www_authenticate::bearer::BearerBuilder
- middleware::HttpAuthentication
Enums
Traits
List of all items in this crate List of all items
Structs
- extractors::AuthenticationError
- extractors::basic::BasicAuth
- extractors::basic::Config
- extractors::bearer::BearerAuth
- extractors::bearer::Config
- headers::authorization::Authorization
- headers::authorization::Basic
- headers::authorization::Bearer
- headers::www_authenticate::WwwAuthenticate
- headers::www_authenticate::basic::Basic
- headers::www_authenticate::bearer::Bearer
- headers::www_authenticate::bearer::BearerBuilder
- middleware::HttpAuthentication
Enums
Traits
actix_web_httpauth::extractors::basic - Rust Module actix_web_httpauth::extractors::basic
source · Expand description
Extractor for the “Basic” HTTP Authentication Scheme.
+actix_web_httpauth::extractors::basic - Rust Module actix_web_httpauth::extractors::basic
source · Expand description
Extractor for the “Basic” HTTP Authentication Scheme.
Structs§
- Extractor for HTTP Basic auth.
BasicAuth extractor configuration used for WWW-Authenticate header later.
BasicAuth in actix_web_httpauth::extractors::basic - Rust Struct actix_web_httpauth::extractors::basic::BasicAuth
source · pub struct BasicAuth(/* private fields */);
Expand description
Extractor for HTTP Basic auth.
+BasicAuth in actix_web_httpauth::extractors::basic - Rust Struct actix_web_httpauth::extractors::basic::BasicAuth
source · pub struct BasicAuth(/* private fields */);
Expand description
Extractor for HTTP Basic auth.
§Examples
use actix_web_httpauth::extractors::basic::BasicAuth;
@@ -40,4 +40,5 @@ App::new()
V: MultiLane<T>,
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
Config in actix_web_httpauth::extractors::basic - Rust Struct actix_web_httpauth::extractors::basic::Config
source · pub struct Config(/* private fields */);
Expand description
BasicAuth extractor configuration used for WWW-Authenticate header later.
+Config in actix_web_httpauth::extractors::basic - Rust Struct actix_web_httpauth::extractors::basic::Config
source · pub struct Config(/* private fields */);
Expand description
BasicAuth extractor configuration used for WWW-Authenticate header later.
Implementations§
source§impl Config
sourcepub fn realm<T>(self, value: T) -> Config
Set challenge realm attribute.
The “realm” attribute indicates the scope of protection in the manner described in HTTP/1.1
@@ -20,4 +20,5 @@
V: MultiLane<T>,
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more
\ No newline at end of file
+[WithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
Error in actix_web_httpauth::extractors::bearer - Rust Enum actix_web_httpauth::extractors::bearer::Error
source · pub enum Error {
+Error in actix_web_httpauth::extractors::bearer - Rust Enum actix_web_httpauth::extractors::bearer::Error
source · pub enum Error {
InvalidRequest,
InvalidToken,
InsufficientScope,
@@ -36,4 +36,5 @@ operator. §fn vzip(self) -> V
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more
WithDispatch] wrapper. Read moreExtractor for the “Bearer” HTTP Authentication Scheme.
+Extractor for the “Bearer” HTTP Authentication Scheme.
BearerAuth extractor configuration.pub struct BearerAuth(/* private fields */);Extractor for HTTP Bearer auth
+pub struct BearerAuth(/* private fields */);Extractor for HTTP Bearer auth
use actix_web_httpauth::extractors::bearer::BearerAuth;
@@ -44,4 +44,5 @@ App::new()
V: MultiLane<T>,Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct Config(/* private fields */);BearerAuth extractor configuration.
pub struct Config(/* private fields */);BearerAuth extractor configuration.
Set challenge scope attribute.
The "scope" attribute is a space-delimited list of case-sensitive
scope values indicating the required scope of the access token for
@@ -23,4 +23,5 @@ described in HTTP/1.1
V: MultiLane<T>,
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreType-safe authentication information extractors.
+Type-safe authentication information extractors.
pub struct AuthenticationError<C: Challenge> { /* private fields */ }Authentication error returned by authentication extractors.
+pub struct AuthenticationError<C: Challenge> { /* private fields */ }Authentication error returned by authentication extractors.
Different extractors may extend AuthenticationError implementation in order to provide access
inner challenge fields.
Extended error customization for HTTP Bearer auth.
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub trait AuthExtractorConfig {
+AuthExtractorConfig in actix_web_httpauth::extractors - Rust pub trait AuthExtractorConfig {
type Inner: Challenge;
// Required method
diff --git a/actix_web_httpauth/headers/authorization/enum.ParseError.html b/actix_web_httpauth/headers/authorization/enum.ParseError.html
index edd4736a2..d1b1b6f6a 100644
--- a/actix_web_httpauth/headers/authorization/enum.ParseError.html
+++ b/actix_web_httpauth/headers/authorization/enum.ParseError.html
@@ -1,4 +1,4 @@
-ParseError in actix_web_httpauth::headers::authorization - Rust pub enum ParseError {
+ParseError in actix_web_httpauth::headers::authorization - Rust pub enum ParseError {
Invalid,
MissingScheme,
MissingField(&'static str),
@@ -14,7 +14,7 @@
§ToStrError(ToStrError)
Unable to convert header into the str.
§Base64DecodeError(DecodeError)
Malformed base64 string.
§Utf8Error(Utf8Error)
Malformed UTF-8 string.
-
Trait Implementations§
source§impl Debug for ParseError
source§impl Display for ParseError
source§impl Error for ParseError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<DecodeError> for ParseError
source§impl From<ToStrError> for ParseError
source§fn from(err: ToStrError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for ParseError
§impl RefUnwindSafe for ParseError
§impl Send for ParseError
§impl Sync for ParseError
§impl Unpin for ParseError
§impl UnwindSafe for ParseError
Blanket Implementations§
Trait Implementations§
source§impl Debug for ParseError
source§impl Display for ParseError
source§impl Error for ParseError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<DecodeError> for ParseError
source§impl From<ToStrError> for ParseError
source§fn from(err: ToStrError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for ParseError
§impl RefUnwindSafe for ParseError
§impl Send for ParseError
§impl Sync for ParseError
§impl Unpin for ParseError
§impl UnwindSafe for ParseError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more
Authorization header and various auth schemes.
Authorization header and various auth schemes.
Authorization header, defined in RFC 7235Basic authentication scheme, defined in RFC 7617Bearer authentication scheme, defined in RFC 6750.Authorization header.Authorization header.pub struct Authorization<S: Scheme>(/* private fields */);Authorization header, defined in RFC 7235
pub struct Authorization<S: Scheme>(/* private fields */);Authorization header, defined in RFC 7235
The “Authorization” header field allows a user agent to authenticate itself with an origin
server—usually, but not necessarily, after receiving a 401 (Unauthorized) response. Its value
consists of credentials containing the authentication information of the user agent for the
@@ -45,4 +45,5 @@ operator. fn vzip(self) -> V
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct Basic { /* private fields */ }Credentials for Basic authentication scheme, defined in RFC 7617
pub struct Basic { /* private fields */ }Credentials for Basic authentication scheme, defined in RFC 7617
Creates Basic credentials with provided user_id and optional
@@ -32,4 +32,5 @@ operator. fn vzip(self) -> V
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct Bearer { /* private fields */ }Credentials for Bearer authentication scheme, defined in RFC 6750.
pub struct Bearer { /* private fields */ }Credentials for Bearer authentication scheme, defined in RFC 6750.
Should be used in combination with Authorization header.
Creates new Bearer credentials with the token provided.
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub trait Scheme: TryIntoHeaderValue + Debug + Display + Clone + Send + Sync {
+Scheme in actix_web_httpauth::headers::authorization - Rust Trait actix_web_httpauth::headers::authorization::Scheme
source · pub trait Scheme: TryIntoHeaderValue + Debug + Display + Clone + Send + Sync {
// Required method
fn parse(header: &HeaderValue) -> Result<Self, ParseError>;
}
Expand description
Authentication scheme for Authorization header.
diff --git a/actix_web_httpauth/headers/index.html b/actix_web_httpauth/headers/index.html
index ec932ba10..1e5ca2929 100644
--- a/actix_web_httpauth/headers/index.html
+++ b/actix_web_httpauth/headers/index.html
@@ -1,2 +1,2 @@
-actix_web_httpauth::headers - Rust Module actix_web_httpauth::headers
source · Expand description
Typed HTTP headers.
+actix_web_httpauth::headers - Rust Module actix_web_httpauth::headers
source · Expand description
Typed HTTP headers.
Modules§
Authorization header and various auth schemes.WWW-Authenticate header and various auth challenges.
actix_web_httpauth::headers::www_authenticate::basic - Rust Module actix_web_httpauth::headers::www_authenticate::basic
source · Expand description
Challenge for the “Basic” HTTP Authentication Scheme.
+actix_web_httpauth::headers::www_authenticate::basic - Rust Module actix_web_httpauth::headers::www_authenticate::basic
source · Expand description
Challenge for the “Basic” HTTP Authentication Scheme.
Structs§
- Challenge for
WWW-Authenticate header with HTTP Basic auth scheme,
described in RFC 7617
Basic in actix_web_httpauth::headers::www_authenticate::basic - Rust Struct actix_web_httpauth::headers::www_authenticate::basic::Basic
source · pub struct Basic { /* private fields */ }
Expand description
Challenge for WWW-Authenticate header with HTTP Basic auth scheme,
+
Basic in actix_web_httpauth::headers::www_authenticate::basic - Rust Struct actix_web_httpauth::headers::www_authenticate::basic::Basic
source · pub struct Basic { /* private fields */ }
Expand description
Challenge for WWW-Authenticate header with HTTP Basic auth scheme,
described in RFC 7617
§Examples
use actix_web_httpauth::headers::www_authenticate::basic::Basic;
@@ -48,4 +48,5 @@ operator. §fn vzip(self) -> V
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
Error in actix_web_httpauth::headers::www_authenticate::bearer - Rust Enum actix_web_httpauth::headers::www_authenticate::bearer::Error
source · pub enum Error {
+Error in actix_web_httpauth::headers::www_authenticate::bearer - Rust Enum actix_web_httpauth::headers::www_authenticate::bearer::Error
source · pub enum Error {
InvalidRequest,
InvalidToken,
InsufficientScope,
@@ -36,4 +36,5 @@ operator. §fn vzip(self) -> V
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more
WithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
Challenge for the “Bearer” HTTP Authentication Scheme.
+Challenge for the “Bearer” HTTP Authentication Scheme.
WWW-Authenticate header with HTTP Bearer auth scheme, described in RFC 6750.Bearer challenge.pub struct Bearer { /* private fields */ }Challenge for WWW-Authenticate header with HTTP Bearer auth scheme, described in RFC 6750.
pub struct Bearer { /* private fields */ }Challenge for WWW-Authenticate header with HTTP Bearer auth scheme, described in RFC 6750.
use actix_web_httpauth::headers::www_authenticate::bearer::{
Bearer, Error,
@@ -51,4 +51,5 @@ operator. §fn vzip(self) -> V
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct BearerBuilder(/* private fields */);Builder for the Bearer challenge.
pub struct BearerBuilder(/* private fields */);Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreWWW-Authenticate header and various auth challenges.
WWW-Authenticate header and various auth challenges.
WWW-Authenticate header, described in RFC 7235.WWW-Authenticate header.pub struct WwwAuthenticate<C: Challenge>(pub C);WWW-Authenticate header, described in RFC 7235.
pub struct WwwAuthenticate<C: Challenge>(pub C);0: Csource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub trait Challenge: TryIntoHeaderValue + Debug + Display + Clone + Send + Sync {
+Challenge in actix_web_httpauth::headers::www_authenticate - Rust Trait actix_web_httpauth::headers::www_authenticate::Challenge
source · pub trait Challenge: TryIntoHeaderValue + Debug + Display + Clone + Send + Sync {
// Required method
fn to_bytes(&self) -> Bytes;
}
Expand description
Authentication challenge for WWW-Authenticate header.
diff --git a/actix_web_httpauth/index.html b/actix_web_httpauth/index.html
index 443b97a94..4ce68efcd 100644
--- a/actix_web_httpauth/index.html
+++ b/actix_web_httpauth/index.html
@@ -1,4 +1,4 @@
-actix_web_httpauth - Rust Crate actix_web_httpauth
source · Expand description
HTTP authentication schemes for Actix Web.
+actix_web_httpauth - Rust Crate actix_web_httpauth
source · Expand description
HTTP authentication schemes for Actix Web.
Provides:
- Typed Authorization and WWW-Authenticate headers
diff --git a/actix_web_httpauth/middleware/index.html b/actix_web_httpauth/middleware/index.html
index 4cc4d23d9..8a388daec 100644
--- a/actix_web_httpauth/middleware/index.html
+++ b/actix_web_httpauth/middleware/index.html
@@ -1,2 +1,2 @@
-actix_web_httpauth::middleware - Rust Module actix_web_httpauth::middleware
source · Expand description
HTTP Authentication middleware.
+actix_web_httpauth::middleware - Rust Module actix_web_httpauth::middleware
source · Expand description
HTTP Authentication middleware.
Structs§
- Middleware for checking HTTP authentication.
HttpAuthentication in actix_web_httpauth::middleware - Rust Struct actix_web_httpauth::middleware::HttpAuthentication
source · pub struct HttpAuthentication<T, F>where
+HttpAuthentication in actix_web_httpauth::middleware - Rust Struct actix_web_httpauth::middleware::HttpAuthentication
source · pub struct HttpAuthentication<T, F>where
T: FromRequest,{ /* private fields */ }
Expand description
Middleware for checking HTTP authentication.
If there is no Authorization header in the request, this middleware returns an error
immediately, without calling the F callback.
@@ -80,4 +80,5 @@ validation callback F.
V: MultiLane<T>,§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more
§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
\ No newline at end of file
diff --git a/actix_ws/all.html b/actix_ws/all.html
index ba0671d83..110114081 100644
--- a/actix_ws/all.html
+++ b/actix_ws/all.html
@@ -1 +1 @@
-List of all items in this crate List of all items
Structs
Enums
Functions
List of all items in this crate List of all items
Structs
Enums
Functions
CloseCode in actix_ws - Rust pub enum CloseCode {
+CloseCode in actix_ws - Rust pub enum CloseCode {
Normal,
Away,
Protocol,
@@ -46,7 +46,7 @@ it should use a randomized delay of 5-30 seconds between attempts.
§Again
Indicates that the server is overloaded and the client should either connect to a different
IP (when multiple targets exist), or reconnect to the same IP when a user has performed
an action.
-
Trait Implementations§
§impl From<CloseCode> for CloseReason
§fn from(code: CloseCode) -> CloseReason
Converts to this type from the input type.§impl PartialEq for CloseCode
Trait Implementations§
§impl From<CloseCode> for CloseReason
§fn from(code: CloseCode) -> CloseReason
Converts to this type from the input type.§impl Copy for CloseCode
§impl Eq for CloseCode
§impl StructuralPartialEq for CloseCode
Auto Trait Implementations§
§impl Freeze for CloseCode
§impl RefUnwindSafe for CloseCode
§impl Send for CloseCode
§impl Sync for CloseCode
§impl Unpin for CloseCode
§impl UnwindSafe for CloseCode
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
@@ -65,4 +65,5 @@ sufficient, and should not be overridden without very good reason.
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
Item in actix_ws - Rust pub enum Item {
+Item in actix_ws - Rust
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub enum Message {
+Message in actix_ws - Rust Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub enum ProtocolError {
+ProtocolError in actix_ws - Rust Enum actix_ws::ProtocolError
pub enum ProtocolError {
UnmaskedFrame,
MaskedFrame,
InvalidOpcode(u8),
@@ -23,7 +23,7 @@
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub fn handle(
+handle in actix_ws - Rust pub fn handle(
req: &HttpRequest,
body: Payload,
) -> Result<(HttpResponse, Session, MessageStream), Error>
Expand description
Begin handling websocket traffic
diff --git a/actix_ws/index.html b/actix_ws/index.html
index 0548973d1..b6ddd662d 100644
--- a/actix_ws/index.html
+++ b/actix_ws/index.html
@@ -1,3 +1,3 @@
-actix_ws - Rust Expand description
WebSockets for Actix Web, without actors.
+actix_ws - Rust Expand description
WebSockets for Actix Web, without actors.
For usage, see documentation on handle().
Structs§
- Reason for closing the connection
- The error representing a closed websocket session
- A stream of Messages from a websocket client
- A handle into the websocket session.
- A response body for Websocket HTTP Requests
Enums§
- Status code used to indicate why an endpoint is closing the WebSocket connection.
- A WebSocket continuation item.
- A WebSocket message.
- WebSocket protocol errors.
Functions§
- Begin handling websocket traffic
CloseReason in actix_ws - Rust Struct actix_ws::CloseReason
pub struct CloseReason {
+CloseReason in actix_ws - Rust Struct actix_ws::CloseReason
pub struct CloseReason {
pub code: CloseCode,
pub description: Option<String>,
}
Expand description
Reason for closing the connection
Fields§
§code: CloseCodeExit code
§description: Option<String>Optional description of the exit code
Trait Implementations§
§impl Clone for CloseReason
§fn clone(&self) -> CloseReason
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for CloseReason
§impl<T> From<(CloseCode, T)> for CloseReason
§fn from(info: (CloseCode, T)) -> CloseReason
Converts to this type from the input type.§impl From<CloseCode> for CloseReason
§fn from(code: CloseCode) -> CloseReason
Converts to this type from the input type.§impl PartialEq for CloseReason
§fn eq(&self, other: &CloseReason) -> bool
§fn from(info: (CloseCode, T)) -> CloseReason
Converts to this type from the input type.§impl From<CloseCode> for CloseReason
§fn from(code: CloseCode) -> CloseReason
Converts to this type from the input type.§impl PartialEq for CloseReason
§fn eq(&self, other: &CloseReason) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for CloseReason
§impl StructuralPartialEq for CloseReason
Auto Trait Implementations§
§impl Freeze for CloseReason
§impl RefUnwindSafe for CloseReason
§impl Send for CloseReason
§impl Sync for CloseReason
§impl Unpin for CloseReason
§impl UnwindSafe for CloseReason
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
@@ -24,4 +24,5 @@ sufficient, and should not be overridden without very good reason.
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read more
\ No newline at end of file
+[WithDispatch] wrapper. Read more
§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
Closed in actix_ws - Rust pub struct Closed;
Expand description
The error representing a closed websocket session
+Closed in actix_ws - Rust pub struct Closed;
Expand description
The error representing a closed websocket session
Trait Implementations§
source§impl Error for Closed
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Closed
§impl RefUnwindSafe for Closed
§impl Send for Closed
§impl Sync for Closed
§impl Unpin for Closed
§impl UnwindSafe for Closed
Blanket Implementations§
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
MessageStream in actix_ws - Rust Struct actix_ws::MessageStream
source · pub struct MessageStream { /* private fields */ }
Expand description
A stream of Messages from a websocket client
+MessageStream in actix_ws - Rust Struct actix_ws::MessageStream
source · pub struct MessageStream { /* private fields */ }
Expand description
A stream of Messages from a websocket client
Messages can be accessed via the stream’s .next() method
Implementations§
source§impl MessageStream
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more§impl<T> ErasedDestructor for Twhere
+ T: 'static,
§impl<T> MaybeSendSync for T
pub struct Session { /* private fields */ }A handle into the websocket session.
+pub struct Session { /* private fields */ }A handle into the websocket session.
This type can be used to send messages into the websocket.
Send text into the websocket
@@ -58,4 +58,5 @@ session.continuation(Item::Last(b"!"[..].into())).Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct StreamingBody { /* private fields */ }A response body for Websocket HTTP Requests
+pub struct StreamingBody { /* private fields */ }A response body for Websocket HTTP Requests
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more1 +all_or_some.rs - source builder.rs - source builder.rs - source error.rs - source error.rs - source inner.rs - source inner.rs - source lib.rs - source lib.rs - source middleware.rs - source middleware.rs - source config.rs - source config.rs - source error.rs - source error.rs - source identity.rs - source identity.rs - source identity_ext.rs - source identity_ext.rs - source lib.rs - source lib.rs - source middleware.rs - source middleware.rs - source builder.rs - source builder.rs - source errors.rs - source errors.rs - source lib.rs - source lib.rs - source middleware.rs - source middleware.rs - source status.rs - source status.rs - source lib.rs - source lib.rs - source config.rs - source config.rs - source lib.rs - source lib.rs - source middleware.rs - source middleware.rs - source session.rs - source session.rs - source session_ext.rs - source session_ext.rs - source cookie.rs - source cookie.rs - source