qubit-fs 0.2.2

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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
// facade.
//! Provider-created synchronous temporary-directory envelope.

use super::TempResourceSpi;
use crate::metadata::OpenedFileInfo;

/// An already-created provider temporary-directory session.
///
/// # Examples
///
/// ```rust
/// use qubit_fs::error::FsResult;
/// use qubit_fs::metadata::{FileKind, FileMetadata, FileSystemId, OpenedFileInfo};
/// use qubit_fs::path::Path;
/// use qubit_fs::spi::{OpenedTempDirectory, TempResourceSpi};
///
/// struct EmptyTemp;
/// impl TempResourceSpi for EmptyTemp {
///     fn persist(
///         &mut self,
///         _: qubit_fs::spi::PersistRequest<'_>,
///     ) -> Result<qubit_fs::temp::PersistOutcome, qubit_fs::spi::SpiPersistFailure> {
///         unreachable!()
///     }
///     fn keep(
///         &mut self,
///     ) -> Result<qubit_fs::temp::PersistOutcome, qubit_fs::spi::SpiPersistFailure> {
///         unreachable!()
///     }
///     fn cleanup(&mut self) -> FsResult<()> {
///         Ok(())
///     }
/// }
/// let info = OpenedFileInfo::new(FileSystemId::new("doc")?, Path::parse("/tmp")?)
///     .with_metadata(FileMetadata::new(FileKind::Directory));
/// let _opened = OpenedTempDirectory::new(info, Box::new(EmptyTemp));
/// # Ok::<(), qubit_fs::FsError>(())
/// ```
pub struct OpenedTempDirectory {
    /// Temporary-directory identity claimed by the provider.
    info: OpenedFileInfo,
    /// Provider lifecycle session.
    session: Box<dyn TempResourceSpi>,
}

impl OpenedTempDirectory {
    /// Wraps an owned temporary-directory session.
    ///
    /// # Parameters
    /// - `info`: Identity and metadata claimed for the temporary directory.
    /// - `session`: Provider lifecycle session.
    ///
    /// # Returns
    /// A temporary-directory envelope for facade validation.
    #[inline]
    #[must_use]
    pub fn new(info: OpenedFileInfo, session: Box<dyn TempResourceSpi>) -> Self {
        Self { info, session }
    }

    /// Returns the provider-owned parts to the facade.
    ///
    /// # Returns
    /// The claimed identity and provider lifecycle session.
    #[inline]
    #[must_use]
    pub(crate) fn into_parts(self) -> (OpenedFileInfo, Box<dyn TempResourceSpi>) {
        (self.info, self.session)
    }
}