opendal/services/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 std::fmt::Debug;
19use std::fmt::Formatter;
20use std::time::Duration;
21
22use serde::Deserialize;
23use serde::Serialize;
24
25/// Config for Moka services support.
26#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
27#[serde(default)]
28#[non_exhaustive]
29pub struct MokaConfig {
30    /// Name for this cache instance.
31    pub name: Option<String>,
32    /// Sets the max capacity of the cache.
33    ///
34    /// Refer to [`moka::sync::CacheBuilder::max_capacity`](https://docs.rs/moka/latest/moka/sync/struct.CacheBuilder.html#method.max_capacity)
35    pub max_capacity: Option<u64>,
36    /// Sets the time to live of the cache.
37    ///
38    /// Refer to [`moka::sync::CacheBuilder::time_to_live`](https://docs.rs/moka/latest/moka/sync/struct.CacheBuilder.html#method.time_to_live)
39    pub time_to_live: Option<Duration>,
40    /// Sets the time to idle of the cache.
41    ///
42    /// Refer to [`moka::sync::CacheBuilder::time_to_idle`](https://docs.rs/moka/latest/moka/sync/struct.CacheBuilder.html#method.time_to_idle)
43    pub time_to_idle: Option<Duration>,
44    /// Sets the segments number of the cache.
45    ///
46    /// Refer to [`moka::sync::CacheBuilder::segments`](https://docs.rs/moka/latest/moka/sync/struct.CacheBuilder.html#method.segments)
47    pub num_segments: Option<usize>,
48
49    /// root path of this backend
50    pub root: Option<String>,
51}
52
53impl Debug for MokaConfig {
54    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
55        f.debug_struct("MokaConfig")
56            .field("name", &self.name)
57            .field("max_capacity", &self.max_capacity)
58            .field("time_to_live", &self.time_to_live)
59            .field("time_to_idle", &self.time_to_idle)
60            .field("num_segments", &self.num_segments)
61            .field("root", &self.root)
62            .finish_non_exhaustive()
63    }
64}
opendal/services/moka/config.rs

opendal/services/moka/
config.rs
