Struct Store

pub struct Store {
    pool: RedisPool,
}

A Redis-backed StoreBackend implementation. The best option for most links deployments.

Configuration

Store backend name: redis

Configuration:

• cluster: Use Redis cluster mode. If this is enabled, cluster information will be requested from Redis nodes (which will fail if the server isn’t in cluster mode). true / false. Default false.
• connect: Connection information in the format of host:port to connect to. When using Redis in cluster mode, you can configure multiple host:port pairs seperated by commas for different nodes (i.e. host1:port1,host2:port2,host3:port3), but only one is required (the others will be automatically discovered). Note that this is not a full URL, just the host and port.
• username: The username to use for the connection, when using ACLs on the server. Don’t specify this when using password-based auth.
• password: The password to use for the Redis connection. This can either be the user’s password (when using ACLs) or the global server password when using password-based authentication.
• database: The database number to use for the Redis connection. Default 0.
• tls: Enable TLS (using system root CAs) when communicating with the Redis server. true / false. Default false.
• pool_size: The number of connections to use in the connection pool. Default 8.

Fields

pool: RedisPool

Trait Implementations

impl Debug for Store

fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl StoreBackend for Store

fn store_type() -> BackendType

where Self: Sized,

Get this implementation’s backend store type. This is used in e.g. the configuration.

fn get_store_type(&self) -> BackendType

Get this implementation’s backend store type. This can be used on trait objects, but is otherwise equivalent to calling Self::store_type().

fn new<'life0, 'async_trait>( config: &'life0 HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a new instance of this StoreBackend. Configuration is provided as a collection of pico-args arguments beginning with --store-. For details about configuring each store backend, see that backend’s documentation.

fn get_redirect<'life0, 'async_trait>( &'life0 self, from: Id, ) -> Pin<Box<dyn Future<Output = Result<Option<Link>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a redirect. Returns the full to link corresponding to the from links ID. A link not existing is not an error, if no matching link is found, Ok(None) is returned.

fn set_redirect<'life0, 'async_trait>( &'life0 self, from: Id, to: Link, ) -> Pin<Box<dyn Future<Output = Result<Option<Link>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set a redirect. from is the ID of the link, while to is the full destination link. If a mapping with this ID already exists, it must be changed to the new one, returning the old one.

fn rem_redirect<'life0, 'async_trait>( &'life0 self, from: Id, ) -> Pin<Box<dyn Future<Output = Result<Option<Link>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove a redirect. from is the ID of the links link to be removed. Returns the old value of the mapping or None if there was no such mapping.

fn get_vanity<'life0, 'async_trait>( &'life0 self, from: Normalized, ) -> Pin<Box<dyn Future<Output = Result<Option<Id>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a vanity path’s ID. Returns the ID of the to link corresponding to the from vanity path. An ID not existing is not an error, if no matching ID is found, None is returned.

fn set_vanity<'life0, 'async_trait>( &'life0 self, from: Normalized, to: Id, ) -> Pin<Box<dyn Future<Output = Result<Option<Id>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set a vanity path for an ID. from is the vanity path of the links ID, while to is the ID itself. If a vanity link with this path already exists, it must be changed to the new one, returning the old one.

fn rem_vanity<'life0, 'async_trait>( &'life0 self, from: Normalized, ) -> Pin<Box<dyn Future<Output = Result<Option<Id>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove a vanity path. from is the vanity path to be removed. Returns the old value of the mapping or None if there was no such mapping.

fn get_statistics<'life0, 'async_trait>( &'life0 self, description: StatisticDescription, ) -> Pin<Box<dyn Future<Output = Result<Vec<(Statistic, StatisticValue)>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get statistics’ values by their description. Returns all matching Statistics and their values for the provided StatisticDescription. Statistics not having been collected is not an error, if no matching statistics are found, an empty Vec is returned.

fn incr_statistic<'life0, 'async_trait>( &'life0 self, statistic: Statistic, ) -> Pin<Box<dyn Future<Output = Result<Option<StatisticValue>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Increment a statistic’s count. The provided Statistic’s value is incremented by 1. Returns the new value of the statistic after the increment, or None if the statistic wasn’t recorded or its new value is not known.

fn rem_statistics<'life0, 'async_trait>( &'life0 self, description: StatisticDescription, ) -> Pin<Box<dyn Future<Output = Result<Vec<(Statistic, StatisticValue)>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove statistics by their description. Deletes all Statistics that match the provided StatisticDescription and returns their values before they were deleted, if they’re available. A statistic not having been collected is not an error, if no matching statistics are found, an empty Vec is returned.