qubit-fs 0.2.0

Provider-neutral synchronous and asynchronous 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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! File information captured as part of opening a stream.

use crate::metadata::FileMetadata;
use crate::metadata::FileSystemId;
use crate::path::Path;

/// Stable file identity plus an optional metadata snapshot captured at open.
///
/// # Examples
///
/// ```rust
/// use qubit_fs::metadata::{FileKind, FileMetadata, FileSystemId, OpenedFileInfo};
/// use qubit_fs::path::Path;
///
/// let info = OpenedFileInfo::new(FileSystemId::new("doc")?, Path::parse("/report")?)
///     .with_metadata(FileMetadata::new(FileKind::File));
/// assert_eq!("/report", info.path().as_str());
/// # Ok::<(), qubit_fs::FsError>(())
/// ```
#[derive(Clone, Debug, PartialEq)]
pub struct OpenedFileInfo {
    /// Stable identity of the filesystem that opened the handle.
    filesystem_id: FileSystemId,
    /// Logical resource path fixed at open time.
    path: Path,
    /// Optional metadata captured without an additional lookup.
    metadata: Option<Box<FileMetadata>>,
}

impl OpenedFileInfo {
    /// Creates opened-file information without an extra metadata lookup.
    ///
    /// # Parameters
    /// - `filesystem_id`: Stable identity of the filesystem that opened the
    ///   handle.
    /// - `path`: Logical resource path fixed at open time.
    ///
    /// # Returns
    /// Opened-file information with no metadata snapshot.
    #[inline]
    #[must_use]
    pub fn new(filesystem_id: FileSystemId, path: Path) -> Self {
        Self {
            filesystem_id,
            path,
            metadata: None,
        }
    }

    /// Attaches metadata already obtained while opening the file.
    ///
    /// Providers should not perform an extra remote `stat` only to populate
    /// this optional snapshot.
    ///
    /// # Parameters
    /// - `metadata`: Metadata observed during open.
    ///
    /// # Returns
    /// Updated opened-file information.
    #[inline]
    #[must_use]
    pub fn with_metadata(mut self, metadata: FileMetadata) -> Self {
        self.metadata = Some(Box::new(metadata));
        self
    }

    /// Returns the stable opened location.
    ///
    /// # Returns
    /// The location captured at open time.
    #[inline]
    #[must_use]
    pub const fn filesystem_id(&self) -> &FileSystemId {
        &self.filesystem_id
    }

    /// Returns the logical path fixed when the provider opened the handle.
    #[inline]
    #[must_use]
    pub const fn path(&self) -> &Path {
        &self.path
    }

    /// Returns the optional metadata snapshot captured during open.
    ///
    /// This is not live metadata. Call [`crate::FileSystem::stat`] when a
    /// current view is required.
    ///
    /// # Returns
    /// The optional open-time snapshot.
    #[inline]
    #[must_use]
    pub fn metadata(&self) -> Option<&FileMetadata> {
        self.metadata.as_deref()
    }
}