opendal/services/redis/
config.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use std::fmt::Debug;
19use std::fmt::Formatter;
20use std::time::Duration;
21
22use serde::Deserialize;
23use serde::Serialize;
24
25/// Config for Redis services support.
26#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
27#[serde(default)]
28#[non_exhaustive]
29pub struct RedisConfig {
30    /// network address of the Redis service. Can be "tcp://127.0.0.1:6379", e.g.
31    ///
32    /// default is "tcp://127.0.0.1:6379"
33    pub endpoint: Option<String>,
34    /// network address of the Redis cluster service. Can be "tcp://127.0.0.1:6379,tcp://127.0.0.1:6380,tcp://127.0.0.1:6381", e.g.
35    ///
36    /// default is None
37    pub cluster_endpoints: Option<String>,
38    /// the username to connect redis service.
39    ///
40    /// default is None
41    pub username: Option<String>,
42    /// the password for authentication
43    ///
44    /// default is None
45    pub password: Option<String>,
46    /// the working directory of the Redis service. Can be "/path/to/dir"
47    ///
48    /// default is "/"
49    pub root: Option<String>,
50    /// the number of DBs redis can take is unlimited
51    ///
52    /// default is db 0
53    pub db: i64,
54    /// The default ttl for put operations.
55    pub default_ttl: Option<Duration>,
56}
57
58impl Debug for RedisConfig {
59    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
60        let mut d = f.debug_struct("RedisConfig");
61
62        d.field("db", &self.db.to_string());
63        d.field("root", &self.root);
64        if let Some(endpoint) = self.endpoint.clone() {
65            d.field("endpoint", &endpoint);
66        }
67        if let Some(cluster_endpoints) = self.cluster_endpoints.clone() {
68            d.field("cluster_endpoints", &cluster_endpoints);
69        }
70        if let Some(username) = self.username.clone() {
71            d.field("username", &username);
72        }
73        if self.password.is_some() {
74            d.field("password", &"<redacted>");
75        }
76
77        d.finish_non_exhaustive()
78    }
79}
opendal/services/redis/config.rs

opendal/services/redis/
config.rs
