vortex-io 0.69.0

Core async and blocking IO traits and implementations, used by IPC and file format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

use std::sync::Arc;

use async_trait::async_trait;
use futures::StreamExt;
use futures::stream::BoxStream;
use vortex_error::VortexResult;

use crate::VortexReadAt;
use crate::filesystem::FileListing;
use crate::filesystem::FileSystem;
use crate::filesystem::FileSystemRef;

/// A [`FileSystem`] decorator that roots all operations under a given prefix.
///
/// Paths returned from [`list`](FileSystem::list) are relative to the prefix, and paths
/// passed to [`open_read`](FileSystem::open_read) are automatically prefixed.
#[derive(Debug)]
pub struct PrefixFileSystem {
    inner: FileSystemRef,
    prefix: String,
}

impl PrefixFileSystem {
    pub fn new(inner: FileSystemRef, prefix: String) -> Self {
        // Normalize to always have a trailing slash for clean concatenation.
        let prefix = format!("{}/", prefix.trim_matches('/'));
        Self { inner, prefix }
    }
}

#[async_trait]
impl FileSystem for PrefixFileSystem {
    fn list(&self, prefix: &str) -> BoxStream<'_, VortexResult<FileListing>> {
        let full_prefix = format!("{}{}", self.prefix, prefix.trim_start_matches('/'));

        let strip_prefix = self.prefix.clone();
        self.inner
            .list(&full_prefix)
            .map(move |result| {
                result.map(|mut listing| {
                    listing.path = listing
                        .path
                        .strip_prefix(&strip_prefix)
                        .unwrap_or(&listing.path)
                        .to_string();
                    listing
                })
            })
            .boxed()
    }

    async fn open_read(&self, path: &str) -> VortexResult<Arc<dyn VortexReadAt>> {
        self.inner
            .open_read(&format!("{}{}", self.prefix, path.trim_start_matches('/')))
            .await
    }
}

impl dyn FileSystem + 'static {
    /// Create a new filesystem that applies the given prefix to all operations on this filesystem.
    pub fn with_prefix(self: Arc<Self>, prefix: String) -> FileSystemRef {
        Arc::new(PrefixFileSystem::new(self, prefix))
    }
}