Skip to main content

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