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

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

use std::time::SystemTime;

use qubit_metadata::Metadata;

use crate::{
    Checksum,
    FileKind,
};

/// Stable and extensible metadata for one filesystem resource.
#[derive(Clone, Debug, PartialEq)]
pub struct FileMetadata {
    /// Provider-neutral resource kind.
    pub kind: FileKind,
    /// Byte length when known.
    pub len: Option<u64>,
    /// Last modification time when known.
    pub modified_at: Option<SystemTime>,
    /// Creation time when known.
    pub created_at: Option<SystemTime>,
    /// Last access time when known.
    pub accessed_at: Option<SystemTime>,
    /// Provider version or HTTP-style ETag when known.
    pub etag: Option<String>,
    /// Content type when known.
    pub content_type: Option<String>,
    /// Content checksum when known.
    pub checksum: Option<Checksum>,
    /// User-defined metadata.
    pub user_metadata: Metadata,
    /// Provider-native metadata.
    pub provider_metadata: Metadata,
}

impl FileMetadata {
    /// Creates metadata with only a file kind.
    ///
    /// # Parameters
    /// - `kind`: Provider-neutral resource kind.
    ///
    /// # Returns
    /// Metadata value with unknown optional fields.
    #[inline]
    #[must_use]
    pub fn new(kind: FileKind) -> Self {
        Self {
            kind,
            len: None,
            modified_at: None,
            created_at: None,
            accessed_at: None,
            etag: None,
            content_type: None,
            checksum: None,
            user_metadata: Metadata::new(),
            provider_metadata: Metadata::new(),
        }
    }

    /// Tells whether this metadata describes a directory-like resource.
    ///
    /// # Returns
    /// `true` for directories and prefixes.
    #[inline]
    #[must_use]
    pub fn is_directory_like(&self) -> bool {
        matches!(self.kind, FileKind::Directory | FileKind::Prefix)
    }
}