MethodNotAllowed
Request method is not allowed.
HeadersNotAllowed
One or more request headers are not allowed.
Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
source
Formats the value using the given formatter. Read more
The lower-level source of this error, if any. Read more
WithDispatch
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Subscriber
Builder for CORS middleware.
Errors that can occur when processing CORS guarded requests.
Opinionated request identity service for Actix Web apps.
Identity policy.
Helper trait that allows to get Identity.
pub struct CookieIdentityPolicy(_);
Use cookies for request identity storage.
pub struct Identity(_);
The extractor type to obtain your identity from a request.
Remember identity.
This method is used to ‘forget’ the current identity on subsequent requests.
Extractor implementation for Identity type.
use actix_identity::Identity; @@ -82,5 +81,5 @@ found associated with the request. WithDispatch wrapper. Read more
pub struct IdentityService<T> { /* private fields */ }
Request identity middleware
pub trait IdentityPolicy: Sized + 'static { @@ -17,5 +16,5 @@
The return type of the middleware
Parse the session from request and load data from a service identity.
Write changes to response
pub trait RequestIdentity { @@ -11,5 +10,5 @@ }
It could be used in middleware but identity policy must be set before any other middleware that needs identity. RequestIdentity is implemented both for ServiceRequest and HttpRequest.
ServiceRequest
HttpRequest
pub const DEFAULT_COOKIE_NAME: &str = "sid";
Default cookie name.
pub const DEFAULT_PERIOD_SECS: u64 = 3600;
Default period (in seconds).
pub const DEFAULT_REQUEST_LIMIT: usize = 5000;
Default request limit.
pub const DEFAULT_SESSION_KEY: &str = "rate-api-id";
Default session key.
Consumes one rate limit unit, returning the status.
Gets the TypeId of self. Read more
TypeId
self
Immutably borrows from an owned value. Read more
Returns how many requests are left in the current period.
Returns a UNIX timestamp in UTC approximately when the next period will begin.
pub enum ProtoBufPayloadError { @@ -44,5 +43,5 @@ WithDispatch wrapper. Read more
pub struct ProtoBuf<T: Message>(pub T);
0: T
pub struct ProtoBufConfig { /* private fields */ }
Change max size of payload. By default max size is 256Kb
pub struct ProtoBufMessage<T: Message + Default> { /* private fields */ }
Create ProtoBufMessage for request.
ProtoBufMessage
Future
Catches unwinding panics while polling the future. Read more
Create a cloneable handle to this future where all handles will resolve to the same result. Read more
Turn this future into a future that yields () on completion and sends +
()
Turn this future into a future that yields () on completion and sends its output to another future on a separate task. Read more
Wrap the future in a Box, pinning it. Read more
pub trait ProtoBufResponseBuilder { fn protobuf<T: Message>(&mut self, value: T) -> Result<HttpResponse, Error>; -}
pub enum Error { @@ -43,5 +42,5 @@ WithDispatch wrapper. Read more
pub enum RespError { @@ -24,15 +23,15 @@ chains of futures; but it occurring at runtime should be considered a catastroph failure. If any error is propagated this way that needs to be handled, then it should be made into a proper option. -
If any error is propagated this way that needs to be handled, then it should be made into a proper option.
backtrace
Returns a stack backtrace, if available, of where this error occurred. Read more
use the Display impl or to_string()
replaced by Error::source, which can support downcasting
Converts to this type from the input type.
Mutably borrows from an owned value. Read more
pub enum RespValue { @@ -28,15 +27,15 @@ arguments, e.g. RPUSH
Push item to Resp array
This will panic if called for anything other than arrays
Return a Result containing either Self or Error. Errors can occur due to either: a) the particular RespValue being incompatible with the required type, or b) a remote Redis error occuring. Read more
Result
Self
Error
RespValue
This method tests for self and other values to be equal, and is used @@ -66,5 +65,5 @@ by ==. WithDispatch wrapper. Read more
other
==
Redis integration for actix.
actix
Into<RespValue>
General purpose actix-redis error.
actix-redis
A single RESP value, this owns the data that is read/to-be written to Redis.
macro_rules! resp_array { @@ -30,5 +29,5 @@ data moved into the corresponding RespValue. If a reference is pro let data = vec!["data", "from", "somewhere", "else"]; let command = resp_array!["RPUSH", "mykey"].append(data); }
pub struct Command(pub RespValue);
Command for send data to Redis
pub struct RedisActor { /* private fields */ }
Redis communication actor
Signing guarantees integrity, but it doesn’t ensure confidentiality: the client cannot tamper with the cookie content, but they can read it.
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.
Max-Age
Expires
Unchanged
The session state has not been modified since its creation/retrieval.
Returns the “default value” for a type. Read more
This method tests for self and other values to be equal, and is used @@ -53,5 +52,5 @@ by ==. WithDispatch wrapper. Read more
Extract a Session object from various actix-web types (e.g. HttpRequest, ServiceRequest, ServiceResponse).
Session
actix-web
ServiceResponse
pub enum LoadError { - Deserialization(Error), - Other(Error), + Deserialization(Error), + Other(Error), }
Possible failures modes for SessionStore::load.
SessionStore::load
Deserialization(Error)
Failed to deserialize session state.
Other(Error)
Something went wrong when retrieving the session state.
pub enum SaveError { - Serialization(Error), - Other(Error), + Serialization(Error), + Other(Error), }
Possible failures modes for SessionStore::save.
SessionStore::save
Serialization(Error)
Failed to serialize session state.
Something went wrong when persisting the session state.
pub enum UpdateError { - Serialization(Error), - Other(Error), + Serialization(Error), + Other(Error), }
Possible failures modes for SessionStore::update.
SessionStore::update
Something went wrong when updating the session state.
The interface to retrieve and save the current session data from/to the chosen storage backend.
Loads the session state associated to a session key.
Persist the session state for a newly created session. Read more
Updates the session state associated to a pre-existing session key.
Deletes a session from the store.
rediss://
A fluent API to configure RedisSessionStore. It takes as input the only required input to create a new instance of RedisSessionStore - a connection string for Redis.
RedisSessionStore
Create a new instance of RedisSessionStore using the default configuration. +
Create a new instance of RedisSessionStore using the default configuration. It takes as input the only required input to create a new instance of RedisSessionStore - a connection string for Redis.
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.
Finalise the builder and return a RedisActorSessionStore instance.
RedisActorSessionStore
You can provide your own custom session store backend by implementing this trait.
async-trait is used for this trait’s definition. Therefore, it @@ -22,6 +21,6 @@ is required for implementations, too. In particular, we use the send-optional va
async-trait
Persist the session state for a newly created session.
Returns the corresponding session key.
Responses produced by the service.
Errors produced by the service.
The TransformService value created by this factory
TransformService
Extract a Session object.
Extractor for the “Basic” HTTP Authentication Scheme
Extractor for HTTP Basic auth.
BasicAuth extractor configuration, used for WWW-Authenticate header later.
BasicAuth
WWW-Authenticate
pub struct BasicAuth(_);
Future that resolves into extracted credentials type.
Parse the authentication credentials from the actix’ ServiceRequest.
Future that resolves to a Self. Read more
The associated error which can be returned.
pub struct Config(_);
BasicAuth extractor configuration, @@ -15,7 +14,7 @@ described in HTTP/1.1
Associated challenge type.
Convert the config instance into a HTTP challenge.
pub enum Error { @@ -21,7 +20,7 @@ for other reasons. token.
Returns HTTP status code suitable for current error type.
Feeds this value into the given Hasher. Read more
Hasher
Extractor for the “Bearer” HTTP Authentication Scheme
BearerAuth extractor configuration.
Bearer authorization error types, described in RFC 6750
pub struct BearerAuth(_);
Extractor for HTTP Bearer auth
Type-safe authentication information extractors
Trait implemented for types that provides configuration for the authentication extractors.
pub struct AuthenticationError<C: Challenge> { /* private fields */ }
Authentication error returned by authentication extractors.
pub trait AuthExtractor: Sized { @@ -21,5 +20,5 @@ authentication scheme.
pub trait AuthExtractorConfig { @@ -14,5 +13,5 @@ for the authentication extractors.
pub enum ParseError { @@ -52,5 +51,5 @@ your own authentication scheme. WithDispatch wrapper. Read more
Authorization header and various auth schemes
Authorization
Authentication scheme for Authorization header.
pub struct Authorization<S: Scheme>(_);
Authorization header, defined in RFC 7235
Converts this type into a mutable reference of the (usually inferred) input type.
Converts this type into a shared reference of the (usually inferred) input type.
Performs the conversion.
The type returned in the event of a conversion error.
Attaches the provided Subscriber to this type, returning a +
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
pub struct Basic { /* private fields */ }
Credentials for Basic authentication scheme, defined in RFC 7617
Basic
Returns client’s user-ID.
Returns client’s password if provided.
This method returns an Ordering between self and other. Read more
Ordering
pub struct Bearer { /* private fields */ }
Credentials for Bearer authentication scheme, defined in RFC6750
Bearer
let credentials = Bearer::new("mF_9.B5f-4.1JqM");
Gets reference to the credentials token.
pub trait Scheme: TryIntoHeaderValue + Debug + Display + Clone + Send + Sync { @@ -11,5 +10,5 @@ }
Try to parse the authentication scheme from the Authorization header.
Typed HTTP headers
WWW-Authenticate header and various auth challenges
Challenge for the “Basic” HTTP Authentication Scheme
Challenge for WWW-Authenticate header with HTTP Basic auth scheme, described in RFC 7617
Challenge for WWW-Authenticate header with HTTP Basic auth scheme, @@ -30,7 +29,7 @@ described in RFC 7617
Challenge for the “Bearer” HTTP Authentication Scheme
Builder for the Bearer challenge.
Challenge for WWW-Authenticate header with HTTP Bearer auth scheme, @@ -35,7 +34,7 @@ described in RFC 6750finish();
pub struct BearerBuilder(_);
Builder
BearerWithDispatch
WWW-Authenticate header, described in RFC 7235
Authentication challenge for WWW-Authenticate header.
pub struct WwwAuthenticate<C: Challenge>(pub C);
0: C
pub trait Challenge: TryIntoHeaderValue + Debug + Display + Clone + Send + Sync { fn to_bytes(&self) -> Bytes; }
Converts the challenge into a bytes suitable for HTTP transmission.
HTTP authentication schemes for actix-web.
HTTP Authentication middleware.
Middleware for checking HTTP authentication.
pub struct HttpAuthentication<T, F> where T: AuthExtractor, { /* private fields */ }
F
fn:
fn
mod
struct
enum
trait
type
macro
const
vec -> usize
* -> vec
str,u8
String,struct:Vec,test
\"string\"
vec::Vec
"+x+"
Access-Control-Request-Headers
Access-Control-Request-Method
Origin
*
Vary
U::from(self)
Domain
HttpOnly
CookieIdentityPolicy
Path
SameSite
Secure
Limiter
Supervisor
RedisActor
SessionMiddlewareBuilder::cookie_content_security
SessionMiddleware
value
SessionMiddleware::new
max_session_length
realm
scope
Scheme
user_id
error
error_description
error_uri
HttpAuthentication