opendal/services/fs/
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::FsBuilder;
22
23/// config for file system
24#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
25#[serde(default)]
26#[non_exhaustive]
27pub struct FsConfig {
28    /// root dir for backend
29    pub root: Option<String>,
30
31    /// tmp dir for atomic write
32    pub atomic_write_dir: Option<String>,
33}
34
35impl crate::Configurator for FsConfig {
36    type Builder = FsBuilder;
37
38    fn from_uri(uri: &crate::types::OperatorUri) -> crate::Result<Self> {
39        let mut map = uri.options().clone();
40
41        if let Some(root) = uri.root().filter(|v| !v.is_empty()) {
42            map.entry("root".to_string())
43                .or_insert_with(|| format!("/{}", root));
44        }
45
46        Self::from_iter(map)
47    }
48
49    fn into_builder(self) -> Self::Builder {
50        FsBuilder { config: self }
51    }
52}
53
54#[cfg(test)]
55mod tests {
56    use super::*;
57    use crate::Configurator;
58    use crate::types::OperatorUri;
59
60    #[test]
61    fn from_uri_extracts_root() {
62        let uri = OperatorUri::new("fs:///tmp/data", Vec::<(String, String)>::new()).unwrap();
63        let cfg = FsConfig::from_uri(&uri).unwrap();
64        assert_eq!(cfg.root.as_deref(), Some("/tmp/data"));
65    }
66}
opendal/services/fs/config.rs

opendal/services/fs/
config.rs
