diff --git a/actix_cors/all.html b/actix_cors/all.html index 8f5969c8b..efff5c1d4 100644 --- a/actix_cors/all.html +++ b/actix_cors/all.html @@ -1,9 +1,9 @@ List of all items in this crate -

List of all items

Structs

Enums

Macros

\ No newline at end of file diff --git a/actix_redis/enum.Error.html b/actix_redis/enum.Error.html index 6414d5398..b956a3857 100644 --- a/actix_redis/enum.Error.html +++ b/actix_redis/enum.Error.html @@ -1,24 +1,24 @@ -Error in actix_redis - Rust +Error in actix_redis - Rust
-

Enum actix_redis::Error

source · [−]
pub enum Error {
+    
Enum actix_redis::Error
source · [−]
pub enum Error {
     Redis(Error),
     NotConnected,
     Disconnected,
-}
Expand description

General purpose actix redis error

+}
Expand description

General purpose actix-redis error.

Variants

Redis(Error)

NotConnected

Receiving message during reconnecting

Disconnected

Cancel all waters when connection get dropped

-

Trait Implementations

Formats the value using the given formatter. Read more

-

Formats the value using the given formatter. Read more

-

The lower-level source of this error, if any. Read more

+

Trait Implementations

Formats the value using the given formatter. Read more

+

Formats the value using the given formatter. Read more

+

The lower-level source of this error, if any. Read more

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred. Read more

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

Read more
👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

-

Performs the conversion.

-

Returns appropriate status code for error. Read more

+

Performs the conversion.

+

Returns appropriate status code for error. Read more

Creates full response for error. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

@@ -33,13 +33,13 @@ From<T> for U chooses to do.

Should always be Self

Converts the given value to a String. Read more

-

The type returned in the event of a conversion error.

+

The type returned in the event of a conversion error.

Performs the conversion.

-

The type returned in the event of a conversion error.

+

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

-
+
\ No newline at end of file diff --git a/actix_redis/enum.RespError.html b/actix_redis/enum.RespError.html index 5f20f933c..787da2f32 100644 --- a/actix_redis/enum.RespError.html +++ b/actix_redis/enum.RespError.html @@ -3,17 +3,17 @@

+

RespError

Variants

Trait Implementations

Auto Trait Implementations

Blanket Implementations

In actix_redis

Enum actix_redis::RespError

[−]
pub enum RespError {
     Internal(String),
     IO(Error),
-    RESP(String, Option<RespValue>),
+    Resp(String, Option<RespValue>),
     Remote(String),
     Connection(ConnectionReason),
     Unexpected(String),
 }

Variants

Internal(String)

A non-specific internal error that prevented an operation from completing

IO(Error)

An IO error occurred

-

RESP(String, Option<RespValue>)

A RESP parsing/serialising error occurred

+

Resp(String, Option<RespValue>)

A RESP parsing/serialising error occurred

Remote(String)

A remote error

Connection(ConnectionReason)

Error creating a connection, or an error with a connection being closed unexpectedly

Unexpected(String)

An unexpected error. In this context “unexpected” means @@ -28,9 +28,9 @@ a proper option.

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred. Read more

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

Read more
👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

-

Performs the conversion.

-

Performs the conversion.

-

Performs the conversion.

+

Performs the conversion.

+

Performs the conversion.

+

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

@@ -44,13 +44,13 @@ a proper option.

From<T> for U chooses to do.

Should always be Self

Converts the given value to a String. Read more

-

The type returned in the event of a conversion error.

+

The type returned in the event of a conversion error.

Performs the conversion.

-

The type returned in the event of a conversion error.

+

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

-
+
\ No newline at end of file diff --git a/actix_redis/enum.RespValue.html b/actix_redis/enum.RespValue.html index cc8c52dc6..0ee4cfb8e 100644 --- a/actix_redis/enum.RespValue.html +++ b/actix_redis/enum.RespValue.html @@ -29,12 +29,12 @@ arguments, e.g. RPUSH

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

-

Performs the conversion.

-

Performs the conversion.

-

Performs the conversion.

+

Performs the conversion.

+

Performs the conversion.

+

Performs the conversion.

Performs the conversion.

-

Performs the conversion.

-

Performs the conversion.

+

Performs the conversion.

+

Performs the conversion.

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

This method tests for self and other values to be equal, and is used @@ -56,13 +56,13 @@ by ==.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

-

The type returned in the event of a conversion error.

+

The type returned in the event of a conversion error.

Performs the conversion.

-

The type returned in the event of a conversion error.

+

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

-
+
\ No newline at end of file diff --git a/actix_redis/enum.SameSite.html b/actix_redis/enum.SameSite.html deleted file mode 100644 index 98336f241..000000000 --- a/actix_redis/enum.SameSite.html +++ /dev/null @@ -1,89 +0,0 @@ -SameSite in actix_redis - Rust - -
-

Enum actix_redis::SameSite

source · [−]
pub enum SameSite {
-    Strict,
-    Lax,
-    None,
-}
Expand description

The SameSite cookie attribute.

-

A cookie with a SameSite attribute is imposed restrictions on when it is -sent to the origin server in a cross-site request. If the SameSite -attribute is “Strict”, then the cookie is never sent in cross-site requests. -If the SameSite attribute is “Lax”, the cookie is only sent in cross-site -requests with “safe” HTTP methods, i.e, GET, HEAD, OPTIONS, TRACE. -If the SameSite attribute is “None”, the cookie is sent in all cross-site -requests if the “Secure” flag is also set, otherwise the cookie is ignored. -This library automatically sets the “Secure” flag on cookies when -same_site is set to SameSite::None as long as secure is not explicitly -set to false.

-

If the SameSite attribute is not present (by not setting SameSite -initally or passing None to Cookie::set_same_site()), then the cookie -will be sent as normal.

-

Note: This cookie attribute is an HTTP draft! Its meaning and -definition are subject to change.

-

Variants

Strict

The “Strict” SameSite attribute.

-

Lax

The “Lax” SameSite attribute.

-

None

The “None” SameSite attribute.

-

Implementations

Returns true if self is SameSite::Strict and false otherwise.

-
Example
-
use cookie::SameSite;
-
-let strict = SameSite::Strict;
-assert!(strict.is_strict());
-assert!(!strict.is_lax());
-assert!(!strict.is_none());
-

Returns true if self is SameSite::Lax and false otherwise.

-
Example
-
use cookie::SameSite;
-
-let lax = SameSite::Lax;
-assert!(lax.is_lax());
-assert!(!lax.is_strict());
-assert!(!lax.is_none());
-

Returns true if self is SameSite::None and false otherwise.

-
Example
-
use cookie::SameSite;
-
-let none = SameSite::None;
-assert!(none.is_none());
-assert!(!none.is_lax());
-assert!(!none.is_strict());
-

Trait Implementations

Returns a copy of the value. Read more

-

Performs copy-assignment from source. Read more

-

Formats the value using the given formatter. Read more

-

Formats the value using the given formatter. Read more

-

Feeds this value into the given Hasher. Read more

-

Feeds a slice of this type into the given Hasher. Read more

-

This method tests for self and other values to be equal, and is used -by ==. Read more

-

This method tests for !=.

-

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

-

Immutably borrows from an owned value. Read more

-

Mutably borrows from an owned value. Read more

-

Compare self to key and return true if they are equal.

-

Returns the argument unchanged.

-

Instruments this type with the provided Span, returning an -Instrumented wrapper. Read more

-

Instruments this type with the current Span, returning an -Instrumented wrapper. Read more

-

Calls U::from(self).

-

That is, this conversion is whatever the implementation of -From<T> for U chooses to do.

-

Should always be Self

-

The resulting type after obtaining ownership.

-

Creates owned data from borrowed data, usually by cloning. Read more

-
🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

-

Converts the given value to a String. Read more

-

The type returned in the event of a conversion error.

-

Performs the conversion.

-

The type returned in the event of a conversion error.

-

Performs the conversion.

-

Attaches the provided Subscriber to this type, returning a -WithDispatch wrapper. Read more

-

Attaches the current default Subscriber to this type, returning a -WithDispatch wrapper. Read more

-
- \ No newline at end of file diff --git a/actix_redis/index.html b/actix_redis/index.html index 3da092fb1..fbd4ae234 100644 --- a/actix_redis/index.html +++ b/actix_redis/index.html @@ -1,17 +1,18 @@ -actix_redis - Rust +actix_redis - Rust
-

Crate actix_redis

source · [−]
Expand description

Redis integration for Actix and session store for Actix Web.

-

Structs

+

Crate actix_redis

+

Crate actix_redis

source · [−]
Expand description

Redis integration for actix.

+

Macros

+
resp_array

Macro to create a RESP array, useful for preparing commands to send. Elements can be any type, or a mixture +of types, that satisfy Into<RespValue>.

+

Structs

Command

Command for send data to Redis

RedisActor

Redis communication actor

-
RedisSession

Use redis as session storage.

Enums

-
Error

General purpose actix redis error

+
Error

General purpose actix-redis error.

RespError
RespValue

A single RESP value, this owns the data that is read/to-be written to Redis.

-
SameSite

The SameSite cookie attribute.

-
+
\ No newline at end of file diff --git a/actix_redis/macro.resp_array!.html b/actix_redis/macro.resp_array!.html new file mode 100644 index 000000000..aef11bda9 --- /dev/null +++ b/actix_redis/macro.resp_array!.html @@ -0,0 +1,11 @@ + + + + + Redirection + + +

Redirecting to macro.resp_array.html...

+ + + \ No newline at end of file diff --git a/actix_redis/macro.resp_array.html b/actix_redis/macro.resp_array.html new file mode 100644 index 000000000..08425a73e --- /dev/null +++ b/actix_redis/macro.resp_array.html @@ -0,0 +1,32 @@ +resp_array in actix_redis - Rust + +
+

Macro actix_redis::resp_array

[−]
macro_rules! resp_array {
+    ($($e:expr),* $(,)?) => { ... };
+}
+
Expand description

Macro to create a RESP array, useful for preparing commands to send. Elements can be any type, or a mixture +of types, that satisfy Into<RespValue>.

+

As a general rule, if a value is moved, the data can be deconstructed (if appropriate, e.g. String) and the raw +data moved into the corresponding RespValue. If a reference is provided, the data will be copied instead.

+

Examples

+
#[macro_use]
+extern crate redis_async;
+
+fn main() {
+    let value = format!("something_{}", 123);
+    resp_array!["SET", "key_name", value];
+}
+

For variable length Redis commands:

+ +
#[macro_use]
+extern crate redis_async;
+
+fn main() {
+    let data = vec!["data", "from", "somewhere", "else"];
+    let command = resp_array!["RPUSH", "mykey"].append(data);
+}
+
+ \ No newline at end of file diff --git a/actix_redis/session/struct.RedisSession.html b/actix_redis/session/struct.RedisSession.html deleted file mode 100644 index ff6040536..000000000 --- a/actix_redis/session/struct.RedisSession.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - - Redirection - - -

Redirecting to ../../actix_redis/struct.RedisSession.html...

- - - \ No newline at end of file diff --git a/actix_redis/sidebar-items.js b/actix_redis/sidebar-items.js index d4e0f4177..416f6b564 100644 --- a/actix_redis/sidebar-items.js +++ b/actix_redis/sidebar-items.js @@ -1 +1 @@ -initSidebarItems({"enum":[["Error","General purpose actix redis error"],["RespError",""],["RespValue","A single RESP value, this owns the data that is read/to-be written to Redis."],["SameSite","The `SameSite` cookie attribute."]],"struct":[["Command","Command for send data to Redis"],["RedisActor","Redis communication actor"],["RedisSession","Use redis as session storage."]]}); \ No newline at end of file +initSidebarItems({"enum":[["Error","General purpose `actix-redis` error."],["RespError",""],["RespValue","A single RESP value, this owns the data that is read/to-be written to Redis."]],"macro":[["resp_array","Macro to create a RESP array, useful for preparing commands to send. Elements can be any type, or a mixture of types, that satisfy `Into`."]],"struct":[["Command","Command for send data to Redis"],["RedisActor","Redis communication actor"]]}); \ No newline at end of file diff --git a/actix_redis/struct.Command.html b/actix_redis/struct.Command.html index 02aa69602..c2bde2efa 100644 --- a/actix_redis/struct.Command.html +++ b/actix_redis/struct.Command.html @@ -22,13 +22,13 @@ successful. Read more

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

-

The type returned in the event of a conversion error.

+

The type returned in the event of a conversion error.

Performs the conversion.

-

The type returned in the event of a conversion error.

+

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

-
+
\ No newline at end of file diff --git a/actix_redis/struct.RedisActor.html b/actix_redis/struct.RedisActor.html index 2a591ada3..ff89dcec8 100644 --- a/actix_redis/struct.RedisActor.html +++ b/actix_redis/struct.RedisActor.html @@ -36,13 +36,13 @@ address. Read more

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

-

The type returned in the event of a conversion error.

+

The type returned in the event of a conversion error.

Performs the conversion.

-

The type returned in the event of a conversion error.

+

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

-
+
\ No newline at end of file diff --git a/actix_redis/struct.RedisSession.html b/actix_redis/struct.RedisSession.html deleted file mode 100644 index 16808fba2..000000000 --- a/actix_redis/struct.RedisSession.html +++ /dev/null @@ -1,58 +0,0 @@ -RedisSession in actix_redis - Rust - -
-

Struct actix_redis::RedisSession

source · [−]
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.

-

Constructor panics if key length is less than 32 bytes.

-

Implementations

Create new redis session backend

-
    -
  • addr - address of the redis server
    • -
-

Set time to live in seconds for session value.

-

Set custom cookie name for session ID.

-

Set custom cookie path.

-

Set custom cookie domain.

-

Set custom cookie secure.

-

If the secure field is set, a cookie will only be transmitted when the -connection is secure - i.e. https.

-

Default is false.

-

Set custom cookie max-age.

-

Use None for session-only cookies.

-

Set custom cookie SameSite attribute.

-

By default, the attribute is omitted.

-

Set custom cookie HttpOnly policy.

-

Default is true.

-

Set a custom cache key generation strategy, expecting session key as input.

-

Trait Implementations

Responses produced by the service.

-

Errors produced by the service.

-

The TransformService value created by this factory

-

Errors produced while building a transform service.

-

The future response value.

-

Creates and returns a new Transform component, asynchronously

-

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

-

Immutably borrows from an owned value. Read more

-

Mutably borrows from an owned value. Read more

-

Returns the argument unchanged.

-

Instruments this type with the provided Span, returning an -Instrumented wrapper. Read more

-

Instruments this type with the current Span, returning an -Instrumented wrapper. Read more

-

Calls U::from(self).

-

That is, this conversion is whatever the implementation of -From<T> for U chooses to do.

-

Should always be Self

-

The type returned in the event of a conversion error.

-

Performs the conversion.

-

The type returned in the event of a conversion error.

-

Performs the conversion.

-

Attaches the provided Subscriber to this type, returning a -WithDispatch wrapper. Read more

-

Attaches the current default Subscriber to this type, returning a -WithDispatch wrapper. Read more

-
- \ No newline at end of file diff --git a/actix_session/all.html b/actix_session/all.html index 7d5f3addc..cbfbaee02 100644 --- a/actix_session/all.html +++ b/actix_session/all.html @@ -1,7 +1,9 @@ List of all items in this crate -