opendal/services/mini_moka/
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 serde::Deserialize;
19use serde::Serialize;
20
21use super::backend::MiniMokaBuilder;
22
23/// Config for mini-moka support.
24#[derive(Debug, Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
25#[serde(default)]
26#[non_exhaustive]
27pub struct MiniMokaConfig {
28    /// Sets the max capacity of the cache.
29    ///
30    /// Refer to [`mini-moka::sync::CacheBuilder::max_capacity`](https://docs.rs/mini-moka/latest/mini_moka/sync/struct.CacheBuilder.html#method.max_capacity)
31    pub max_capacity: Option<u64>,
32    /// Sets the time to live of the cache.
33    ///
34    /// Refer to [`mini-moka::sync::CacheBuilder::time_to_live`](https://docs.rs/mini-moka/latest/mini_moka/sync/struct.CacheBuilder.html#method.time_to_live)
35    pub time_to_live: Option<String>,
36    /// Sets the time to idle of the cache.
37    ///
38    /// Refer to [`mini-moka::sync::CacheBuilder::time_to_idle`](https://docs.rs/mini-moka/latest/mini_moka/sync/struct.CacheBuilder.html#method.time_to_idle)
39    pub time_to_idle: Option<String>,
40
41    /// root path of this backend
42    pub root: Option<String>,
43}
44
45impl crate::Configurator for MiniMokaConfig {
46    type Builder = MiniMokaBuilder;
47
48    fn from_uri(uri: &crate::types::OperatorUri) -> crate::Result<Self> {
49        let mut map = uri.options().clone();
50
51        if let Some(root) = uri.root() {
52            if !root.is_empty() {
53                map.insert("root".to_string(), root.to_string());
54            }
55        }
56
57        Self::from_iter(map)
58    }
59
60    fn into_builder(self) -> Self::Builder {
61        MiniMokaBuilder { config: self }
62    }
63}
64
65#[cfg(test)]
66mod tests {
67    use super::*;
68    use crate::Configurator;
69    use crate::types::OperatorUri;
70
71    #[test]
72    fn from_uri_sets_root_and_preserves_ttl() {
73        let uri = OperatorUri::new(
74            "mini-moka:///session",
75            vec![("time_to_live".to_string(), "300s".to_string())],
76        )
77        .unwrap();
78
79        let cfg = MiniMokaConfig::from_uri(&uri).unwrap();
80        assert_eq!(cfg.root.as_deref(), Some("session"));
81        assert!(cfg.time_to_live.is_some());
82    }
83}