Struct opendal::services::Redis

pub struct Redis { /* private fields */ }

Redis services support.

Capabilities

This service can be used to:

• read
• write
• list
• scan
• presign
• blocking

Configuration

• root: Set the working directory of OpenDAL
• endpoint: Set the network address of redis server
• 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::services::Redis;
use opendal::Object;
use opendal::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();
    let _: Object = op.object("test_file");
    Ok(())
}

Implementations

impl RedisBuilder

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

set the network address of redis service.

currently supported schemes:

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

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

set the username for redis

default: no username

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

set the password for redis

default: no password

pub fn db(&mut self, db: i64) -> &mut Self

set the db used in redis

default: 0

pub fn default_ttl(&mut self, ttl: Duration) -> &mut Self

Set the default ttl for redis services.

If set, we will specify EX for write operations.

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

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

default: “/”

Trait Implementations

impl Builder for RedisBuilder

const SCHEME: Scheme = Scheme::Redis

Associated scheme for this builder.

type Accessor = Backend<Adapter>

The accessor that built by this builder.

fn from_map(map: HashMap<String, String>) -> Self

Construct a builder from given map.

fn build(&mut self) -> Result<Self::Accessor>

Consume the accessor builder to build a service.

fn from_iter(iter: impl Iterator<Item = (String, String)>) -> Selfwhere
    Self: Sized,

Construct a builder from given iterator.

fn from_env() -> Selfwhere
    Self: Sized,

Construct a builder from envs.

impl Clone for RedisBuilder

fn clone(&self) -> RedisBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RedisBuilder

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

Formats the value using the given formatter.

impl Default for RedisBuilder

fn default() -> RedisBuilder

Returns the “default value” for a type.