Struct Redis 

pub struct Redis { /* private fields */ }

Redis services support.

Capabilities

This service can be used to:

• create_dir
• stat
• read
• write
• delete
• list
• copy
• rename
• presign

Configuration

• root: Set the working directory of OpenDAL
• endpoint: Set the network address of redis server
• cluster_endpoints: Set the network address of redis cluster server. This parameter is mutually exclusive with the endpoint parameter.
• username: Set the username of Redis
• password: Set the password for authentication
• db: Set the DB of redis

You can refer to RedisBuilder’s docs for more information

Example

Via Builder

use anyhow::Result;
use opendal_core::services::Redis;
use opendal_core::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Redis::default();

    // this will build a Operator accessing Redis which runs on tcp://localhost:6379
    let op: Operator = Operator::new(builder)?.finish();
    Ok(())
}

Implementations

impl RedisBuilder

pub fn endpoint(self, endpoint: &str) -> RedisBuilder

set the network address of redis service.

currently supported schemes:

• no scheme: will be seen as “tcp”
• “tcp” or “redis”: unsecured redis connections
• “rediss”: secured redis connections
• “unix” or “redis+unix”: unix socket connection

pub fn cluster_endpoints(self, cluster_endpoints: &str) -> RedisBuilder

set the network address of redis cluster service. This parameter is mutually exclusive with the endpoint parameter.

currently supported schemes:

• no scheme: will be seen as “tcp”
• “tcp” or “redis”: unsecured redis connections
• “rediss”: secured redis connections
• “unix” or “redis+unix”: unix socket connection

pub fn username(self, username: &str) -> RedisBuilder

set the username for redis

default: no username

pub fn password(self, password: &str) -> RedisBuilder

set the password for redis

default: no password

pub fn db(self, db: i64) -> RedisBuilder

set the db used in redis

default: 0

pub fn default_ttl(self, ttl: Duration) -> RedisBuilder

Set the default ttl for redis services.

If set, we will specify EX for write operations.

pub fn root(self, root: &str) -> RedisBuilder

set the working directory, all operations will be performed under it.

default: “/”

pub fn connection_pool_max_size(self, max_size: usize) -> RedisBuilder

Sets the maximum number of connections managed by the pool.

Defaults to 10.

Panics

Will panic if max_size is 0.

Trait Implementations

impl Builder for RedisBuilder

type Config = RedisConfig

Associated configuration for this builder.

fn build(self) -> Result<impl Access, Error>

Consume the accessor builder to build a service.

impl Debug for RedisBuilder

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

Formats the value using the given formatter.

impl Default for RedisBuilder

fn default() -> RedisBuilder

Returns the “default value” for a type.