opendal/services/fs/
lister.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::path::Path;
19use std::path::PathBuf;
20
21use crate::raw::*;
22use crate::EntryMode;
23use crate::Metadata;
24use crate::Result;
25
26pub struct FsLister<P> {
27    root: PathBuf,
28
29    current_path: Option<String>,
30
31    rd: P,
32}
33
34impl<P> FsLister<P> {
35    pub fn new(root: &Path, path: &str, rd: P) -> Self {
36        Self {
37            root: root.to_owned(),
38            current_path: Some(path.to_string()),
39            rd,
40        }
41    }
42}
43
44/// # Safety
45///
46/// We will only take `&mut Self` reference for FsLister.
47unsafe impl<P> Sync for FsLister<P> {}
48
49impl oio::List for FsLister<tokio::fs::ReadDir> {
50    async fn next(&mut self) -> Result<Option<oio::Entry>> {
51        // since list should return path itself, we return it first
52        if let Some(path) = self.current_path.take() {
53            let e = oio::Entry::new(path.as_str(), Metadata::new(EntryMode::DIR));
54            return Ok(Some(e));
55        }
56
57        let Some(de) = self.rd.next_entry().await.map_err(new_std_io_error)? else {
58            return Ok(None);
59        };
60
61        let entry_path = de.path();
62        let rel_path = normalize_path(
63            &entry_path
64                .strip_prefix(&self.root)
65                .expect("cannot fail because the prefix is iterated")
66                .to_string_lossy()
67                .replace('\\', "/"),
68        );
69
70        let ft = de.file_type().await.map_err(new_std_io_error)?;
71        let entry = if ft.is_dir() {
72            // Make sure we are returning the correct path.
73            oio::Entry::new(&format!("{rel_path}/"), Metadata::new(EntryMode::DIR))
74        } else if ft.is_file() {
75            oio::Entry::new(&rel_path, Metadata::new(EntryMode::FILE))
76        } else {
77            oio::Entry::new(&rel_path, Metadata::new(EntryMode::Unknown))
78        };
79        Ok(Some(entry))
80    }
81}
82
83impl oio::BlockingList for FsLister<std::fs::ReadDir> {
84    fn next(&mut self) -> Result<Option<oio::Entry>> {
85        // since list should return path itself, we return it first
86        if let Some(path) = self.current_path.take() {
87            let e = oio::Entry::new(path.as_str(), Metadata::new(EntryMode::DIR));
88            return Ok(Some(e));
89        }
90
91        let de = match self.rd.next() {
92            Some(de) => de.map_err(new_std_io_error)?,
93            None => return Ok(None),
94        };
95
96        let entry_path = de.path();
97        let rel_path = normalize_path(
98            &entry_path
99                .strip_prefix(&self.root)
100                .expect("cannot fail because the prefix is iterated")
101                .to_string_lossy()
102                .replace('\\', "/"),
103        );
104
105        let ft = de.file_type().map_err(new_std_io_error)?;
106        let entry = if ft.is_dir() {
107            // Make sure we are returning the correct path.
108            oio::Entry::new(&format!("{rel_path}/"), Metadata::new(EntryMode::DIR))
109        } else if ft.is_file() {
110            oio::Entry::new(&rel_path, Metadata::new(EntryMode::FILE))
111        } else {
112            oio::Entry::new(&rel_path, Metadata::new(EntryMode::Unknown))
113        };
114
115        Ok(Some(entry))
116    }
117}
opendal/services/fs/lister.rs

opendal/services/fs/
lister.rs
