Struct reool::RedisPool[][src]

pub struct RedisPool<T: Poolable = ConnectionFlavour> { /* fields omitted */ }
Expand description

A pool to one or more Redis instances.

This is the core type of this library.

Overview

Each RedisPool consist of one or more sub pools whereas each sub pool is only ever connected to one Redis node.

So the number of sub pools is usually the number of nodes to connect to. Furthermore the number of sub pools can be increased via the configuration.

Reool uses a stream to enqueue checkouts. Furthermore the number of buffered checkout requests is always limited. Having multiple sub pools will increase the number of checkout requests that can be enqueued.

When having more that one sub pool Reool will retry checkout attempts on different sub pools.

ConnectionLike

The pool itself implements ConnectionLike. This is a convinience functionality for executing a single redis command. The checkout will be done with the DefaultCheckoutMode defined for the pool. Furthermore ConnectionLike::get_db will always return -1.

Implementations

Checkout a new connection and if the request has to be enqueued use a timeout as defined by the pool as a default.

Checkout a new connection and choose whether to wait for a connection or not as defined by the CheckoutMode.

Creates a clone with the given default command timeout.

This creates a new instance since mutating this might go unnoticed as callers which pass the pool as a mutable reference would not expect this value to be changed by downstream code as passing this mutably is mostly for the purpose of directly executing Redis commands.

Ping all the nodes which this pool is connected to.

timeout is the maximum time allowed for a ping.

This method only fails with () if the underlying connection does not support pinging. All other errors will be contained in the returned Ping struct.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Sends an already encoded (packed) command into the TCP socket and reads the single response from it. Read more

Sends multiple already encoded (packed) command into the TCP socket and reads count responses from it. This is used to implement pipelining. Read more

Returns the database this connection is bound to. Note that this information might be unreliable because it’s initially cached and also might be incorrect if the connection like object is not actually connected. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Get the value of a key. If key is a vec this becomes an MGET.

Gets all keys matching pattern

Set the string value of a key.

Sets multiple keys to their values.

Set the value and expiration of a key.

Set the value and expiration in milliseconds of a key.

Set the value of a key, only if the key does not exist

Sets multiple keys to their values failing if at least one already exists.

Set the string value of a key and return its old value.

Get a range of bytes/substring from the value of a key. Negative values provide an offset from the end of the value.

Overwrite the part of the value stored in key at the specified offset.

Delete one or more keys.

Determine if a key exists.

Set a key’s time to live in seconds.

Set the expiration for a key as a UNIX timestamp.

Set a key’s time to live in milliseconds.

Set the expiration for a key as a UNIX timestamp in milliseconds.

Remove the expiration from a key.

Get the expiration time of a key.

Get the expiration time of a key in milliseconds.

Rename a key.

Rename a key, only if the new key does not exist.

Unlink one or more keys.

Append a value to a key.

Increment the numeric value of a key by the given amount. This issues a INCRBY or INCRBYFLOAT depending on the type. Read more

Decrement the numeric value of a key by the given amount.

Sets or clears the bit at offset in the string value stored at key.

Returns the bit value at offset in the string value stored at key.

Count set bits in a string.

Count set bits in a string in a range.

Perform a bitwise AND between multiple keys (containing string values) and store the result in the destination key. Read more

Perform a bitwise OR between multiple keys (containing string values) and store the result in the destination key. Read more

Perform a bitwise XOR between multiple keys (containing string values) and store the result in the destination key. Read more

Perform a bitwise NOT of the key (containing string values) and store the result in the destination key. Read more

Get the length of the value stored in a key.

Gets a single (or multiple) fields from a hash.

Deletes a single (or multiple) fields from a hash.

Sets a single field in a hash.

Sets a single field in a hash if it does not exist.

Sets a multiple fields in a hash.

Increments a value.

Checks if a field in a hash exists.

Gets all the keys in a hash.

Gets all the values in a hash.

Gets all the fields and values in a hash.

Gets the length of a hash.

Remove and get the first element in a list, or block until one is available.

Remove and get the last element in a list, or block until one is available.

Pop a value from a list, push it to another list and return it; or block until one is available. Read more

Get an element from a list by its index.

Insert an element before another element in a list.

Insert an element after another element in a list.

Returns the length of the list stored at key.

Removes and returns the up to count first elements of the list stored at key. Read more

Returns the index of the first matching value of the list stored at key.

Insert all the specified values at the head of the list stored at key.

Inserts a value at the head of the list stored at key, only if key already exists and holds a list. Read more

Returns the specified elements of the list stored at key.

Removes the first count occurrences of elements equal to value from the list stored at key. Read more

Trim an existing list so that it will contain only the specified range of elements specified. Read more

Sets the list element at index to value

Removes and returns the up to count last elements of the list stored at key Read more

Pop a value from a list, push it to another list and return it.

Insert all the specified values at the tail of the list stored at key.

Inserts value at the tail of the list stored at key, only if key already exists and holds a list. Read more

Add one or more members to a set.

Get the number of members in a set.

Subtract multiple sets.

Subtract multiple sets and store the resulting set in a key.

Intersect multiple sets.

Intersect multiple sets and store the resulting set in a key.

Determine if a given value is a member of a set.

Get all the members in a set.

Move a member from one set to another.

Remove and return a random member from a set.

Get one random member from a set.

Get multiple random members from a set.

Remove one or more members from a set.

Add multiple sets.

Add multiple sets and store the resulting set in a key.

Add one member to a sorted set, or update its score if it already exists.

Add multiple members to a sorted set, or update its score if it already exists.

Get the number of members in a sorted set.

Count the members in a sorted set with scores within the given values.

Increments the member in a sorted set at key by delta. If the member does not exist, it is added with delta as its score. Read more

Intersect multiple sorted sets and store the resulting sorted set in a new key using SUM as aggregation function. Read more

Intersect multiple sorted sets and store the resulting sorted set in a new key using MIN as aggregation function. Read more

Intersect multiple sorted sets and store the resulting sorted set in a new key using MAX as aggregation function. Read more

Count the number of members in a sorted set between a given lexicographical range.

Removes and returns up to count members with the highest scores in a sorted set

Removes and returns up to count members with the lowest scores in a sorted set

Return a range of members in a sorted set, by index

Return a range of members in a sorted set, by index with scores.

Return a range of members in a sorted set, by lexicographical range.

Return a range of members in a sorted set, by lexicographical range with offset and limit. Read more

Return a range of members in a sorted set, by lexicographical range.

Return a range of members in a sorted set, by lexicographical range with offset and limit. Read more

Return a range of members in a sorted set, by score.

Return a range of members in a sorted set, by score with scores.

Return a range of members in a sorted set, by score with limit.

Return a range of members in a sorted set, by score with limit with scores.

Determine the index of a member in a sorted set.

Remove one or more members from a sorted set.

Remove all members in a sorted set between the given lexicographical range.

Remove all members in a sorted set within the given indexes.

Remove all members in a sorted set within the given scores.

Return a range of members in a sorted set, by index, with scores ordered from high to low. Read more

Return a range of members in a sorted set, by index, with scores ordered from high to low. Read more

Return a range of members in a sorted set, by score.

Return a range of members in a sorted set, by score with scores.

Return a range of members in a sorted set, by score with limit.

Return a range of members in a sorted set, by score with limit with scores.

Determine the index of a member in a sorted set, with scores ordered from high to low.

Get the score associated with the given member in a sorted set.

Unions multiple sorted sets and store the resulting sorted set in a new key using SUM as aggregation function. Read more

Unions multiple sorted sets and store the resulting sorted set in a new key using MIN as aggregation function. Read more

Unions multiple sorted sets and store the resulting sorted set in a new key using MAX as aggregation function. Read more

Adds the specified elements to the specified HyperLogLog.

Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s). Read more

Merge N different HyperLogLogs into a single one.

Posts a message to the given channel.

When Redis is configured to use an ACL file (with the aclfile configuration option), this command will reload the ACLs from the file, replacing all the current ACL rules with the ones defined in the file. Read more

When Redis is configured to use an ACL file (with the aclfile configuration option), this command will save the currently defined ACLs from the server memory to the ACL file. Read more

Shows the currently active ACL rules in the Redis server.

Shows a list of all the usernames of the currently configured users in the Redis ACL system. Read more

Returns all the rules defined for an existing ACL user.

Creates an ACL user without any privilege.

Creates an ACL user with the specified rules or modify the rules of an existing user. Read more

Delete all the specified ACL users and terminate all the connections that are authenticated with such users. Read more

Shows the available ACL categories.

Shows all the Redis commands in the specified category.

Generates a 256-bits password starting from /dev/urandom if available.

Generates a 1-to-1024-bits password starting from /dev/urandom if available.

Returns the username the current connection is authenticated with.

Shows a list of recent ACL security events

Clears the ACL log.

Returns a helpful text describing the different subcommands.

Adds the specified geospatial items to the specified key. Read more

Return the distance between two members in the geospatial index represented by the sorted set. Read more

Return valid Geohash strings representing the position of one or more members of the geospatial index represented by the sorted set at key. Read more

Return the positions of all the specified members of the geospatial index represented by the sorted set at key. Read more

Return the members of a sorted set populated with geospatial information using geo_add, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius). Read more

Retrieve members selected by distance with the center of member. The member itself is always contained in the results. Read more

Ack pending stream messages checked out by a consumer. Read more

Add a stream message by key. Use * as the id for the current timestamp. Read more

BTreeMap variant for adding a stream message by key. Use * as the id for the current timestamp. Read more

Add a stream message while capping the stream at a maxlength. Read more

BTreeMap variant for adding a stream message while capping the stream at a maxlength. Read more

Claim pending, unacked messages, after some period of time, currently checked out by another consumer. Read more

This is the optional arguments version for claiming unacked, pending messages currently checked out by another consumer. Read more

Deletes a list of ids for a given stream key. Read more

This command is used for creating a consumer group. It expects the stream key to already exist. Otherwise, use xgroup_create_mkstream if it doesn’t. The id is the starting message id all consumers should read from. Use $ If you want all consumers to read from the last message added to stream. Read more

This is the alternate version for creating a consumer group which makes the stream if it doesn’t exist. Read more

Alter which id you want consumers to begin reading from an existing consumer group. Read more

Destroy an existing consumer group for a given stream key Read more

This deletes a consumer from an existing consumer group for given stream `key. Read more

This returns all info details about which consumers have read messages for given consumer group. Take note of the StreamInfoConsumersReply return type. Read more

Returns all consumer groups created for a given stream key. Take note of the StreamInfoGroupsReply return type. Read more

Returns info about high-level stream details (first & last message id, length, number of groups, etc.) Take note of the StreamInfoStreamReply return type. Read more

Returns the number of messages for a given stream key. Read more

This is a basic version of making XPENDING command calls which only passes a stream key and consumer group and it returns details about which consumers have pending messages that haven’t been acked. Read more

This XPENDING version returns a list of all messages over the range. You can use this for paginating pending messages (but without the message HashMap). Read more

An alternate version of xpending_count which filters by consumer name. Read more

Returns a range of messages in a given stream key. Read more

A helper method for automatically returning all messages in a stream by key. Use with caution! Read more

A method for paginating a stream by key. Read more

Read a list of ids for each stream key. This is the basic form of reading streams. For more advanced control, like blocking, limiting, or reading by consumer group, see xread_options. Read more

This method handles setting optional arguments for XREAD or XREADGROUP Redis commands. Read more

This is the reverse version of xrange. The same rules apply for start and end here. Read more

This is the reverse version of xrange_all. The same rules apply for start and end here. Read more

This is the reverse version of xrange_count. The same rules apply for start and end here. Read more

Trim a stream key to a MAXLEN count. Read more

Incrementally iterate the keys space.

Incrementally iterate set elements for elements matching a pattern.

Incrementally iterate hash fields and associated values.

Incrementally iterate hash fields and associated values for field names matching a pattern. Read more

Incrementally iterate set elements.

Incrementally iterate set elements for elements matching a pattern.

Incrementally iterate sorted set elements.

Incrementally iterate sorted set elements for elements matching a pattern.

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

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)

recently added

Uses borrowed data to replace owned data, usually by cloning. 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.