qubit-fs 0.1.0

Pluggable filesystem abstraction for Rust
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

/*******************************************************************************
 *
 *    Copyright (c) 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
 ******************************************************************************/
//! Full filesystem URI model.

use qubit_metadata::Metadata;
use url::Url;

use crate::{
    FsAuthority,
    FsError,
    FsOperation,
    FsPath,
    FsResult,
};

/// Full filesystem URI.
#[derive(Clone, Debug, PartialEq)]
pub struct FsUri {
    /// Provider scheme.
    pub scheme: String,
    /// Optional URI authority.
    pub authority: Option<FsAuthority>,
    /// Provider-local path.
    pub path: FsPath,
    /// Non-sensitive query options.
    pub query: Metadata,
}

impl FsUri {
    /// Parses a full filesystem URI.
    ///
    /// # Parameters
    /// - `uri`: URI string to parse.
    ///
    /// # Returns
    /// Parsed filesystem URI.
    ///
    /// # Errors
    /// Returns [`FsError`] when the URI or its path is invalid.
    pub fn parse(uri: &str) -> FsResult<Self> {
        let parsed = Url::parse(uri).map_err(|error| {
            FsError::with_source(
                crate::FsErrorKind::InvalidPath,
                FsOperation::ParseUri,
                "invalid filesystem URI",
                error,
            )
        })?;
        let scheme = parsed.scheme().to_ascii_lowercase();
        let authority = parsed.host_str().map(|host| {
            let mut authority = FsAuthority::new(host);
            if let Some(port) = parsed.port() {
                authority = authority.with_port(port);
            }
            let username = parsed.username();
            if !username.is_empty() {
                authority = authority.with_username(username);
            }
            authority
        });
        let path = FsPath::parse(parsed.path()).map_err(|error| {
            FsError::new(
                error.kind(),
                FsOperation::ParseUri,
                "URI path is not a valid filesystem path",
            )
        })?;
        let mut query = Metadata::new();
        for (key, value) in parsed.query_pairs() {
            query.set(key.as_ref(), value.into_owned());
        }
        Ok(Self {
            scheme,
            authority,
            path,
            query,
        })
    }
}