opendal/services/memcached/
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::time::Duration;
20
21use serde::Deserialize;
22use serde::Serialize;
23
24use super::MEMCACHED_SCHEME;
25use super::backend::MemcachedBuilder;
26
27/// Config for MemCached services support
28#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
29#[serde(default)]
30#[non_exhaustive]
31pub struct MemcachedConfig {
32    /// network address of the memcached service.
33    ///
34    /// For example: "tcp://localhost:11211"
35    pub endpoint: Option<String>,
36    /// the working directory of the service. Can be "/path/to/dir"
37    ///
38    /// default is "/"
39    pub root: Option<String>,
40    /// Memcached username, optional.
41    pub username: Option<String>,
42    /// Memcached password, optional.
43    pub password: Option<String>,
44    /// The default ttl for put operations.
45    pub default_ttl: Option<Duration>,
46    /// The maximum number of connections allowed.
47    ///
48    /// default is 10
49    pub connection_pool_max_size: Option<u32>,
50}
51
52impl Debug for MemcachedConfig {
53    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
54        f.debug_struct("MemcachedConfig")
55            .field("endpoint", &self.endpoint)
56            .field("root", &self.root)
57            .field("username", &self.username)
58            .field("default_ttl", &self.default_ttl)
59            .finish_non_exhaustive()
60    }
61}
62
63impl crate::Configurator for MemcachedConfig {
64    type Builder = MemcachedBuilder;
65
66    fn from_uri(uri: &crate::types::OperatorUri) -> crate::Result<Self> {
67        let authority = uri.authority().ok_or_else(|| {
68            crate::Error::new(crate::ErrorKind::ConfigInvalid, "uri authority is required")
69                .with_context("service", MEMCACHED_SCHEME)
70        })?;
71
72        let mut map = uri.options().clone();
73        map.insert("endpoint".to_string(), format!("tcp://{authority}"));
74
75        if let Some(root) = uri.root() {
76            if !root.is_empty() {
77                map.insert("root".to_string(), root.to_string());
78            }
79        }
80
81        Self::from_iter(map)
82    }
83
84    fn into_builder(self) -> Self::Builder {
85        MemcachedBuilder { config: self }
86    }
87}
88
89#[cfg(test)]
90mod tests {
91    use super::*;
92    use crate::Configurator;
93    use crate::types::OperatorUri;
94
95    #[test]
96    fn from_uri_sets_endpoint_and_root() {
97        let uri = OperatorUri::new(
98            "memcached://cache.local:11211/app/session",
99            Vec::<(String, String)>::new(),
100        )
101        .unwrap();
102
103        let cfg = MemcachedConfig::from_uri(&uri).unwrap();
104        assert_eq!(cfg.endpoint.as_deref(), Some("tcp://cache.local:11211"));
105        assert_eq!(cfg.root.as_deref(), Some("app/session"));
106    }
107}
opendal/services/memcached/config.rs

opendal/services/memcached/
config.rs
