qubit_fs/spi/
opened_temp_file.rs

1// =============================================================================
2//    Copyright (c) 2026 Haixing Hu.
3//
4//    SPDX-License-Identifier: Apache-2.0
5//
6//    Licensed under the Apache License, Version 2.0.
7// =============================================================================
8// facade.
9//! Provider-created synchronous temporary-file envelope.
10
11use super::TempResourceSpi;
12use crate::metadata::OpenedFileInfo;
13
14/// An already-created provider temporary-file session.
15///
16/// # Examples
17///
18/// ```rust
19/// use qubit_fs::error::FsResult;
20/// use qubit_fs::metadata::{FileKind, FileMetadata, FileSystemId, OpenedFileInfo};
21/// use qubit_fs::path::Path;
22/// use qubit_fs::spi::TempResourceSpi;
23/// use qubit_fs::spi::OpenedTempFile;
24///
25/// struct EmptyTemp;
26/// impl TempResourceSpi for EmptyTemp {
27///     fn persist(
28///         &mut self,
29///         _: qubit_fs::spi::PersistRequest<'_>,
30///     ) -> Result<qubit_fs::temp::PersistOutcome, qubit_fs::spi::SpiPersistFailure> {
31///         unreachable!()
32///     }
33///     fn keep(
34///         &mut self,
35///     ) -> Result<qubit_fs::temp::PersistOutcome, qubit_fs::spi::SpiPersistFailure> {
36///         unreachable!()
37///     }
38///     fn cleanup(&mut self) -> FsResult<()> {
39///         Ok(())
40///     }
41/// }
42/// let info = OpenedFileInfo::new(FileSystemId::new("doc")?, Path::parse("/scratch")?)
43///     .with_metadata(FileMetadata::new(FileKind::File));
44/// let _opened = OpenedTempFile::new(info, Box::new(EmptyTemp));
45/// # Ok::<(), qubit_fs::FsError>(())
46/// ```
47pub struct OpenedTempFile {
48    /// Temporary-file identity claimed by the provider.
49    info: OpenedFileInfo,
50    /// Provider lifecycle session.
51    session: Box<dyn TempResourceSpi>,
52}
53
54impl OpenedTempFile {
55    /// Wraps an owned temporary-file session.
56    ///
57    /// # Parameters
58    /// - `info`: Identity and metadata claimed for the temporary file.
59    /// - `session`: Provider lifecycle session.
60    ///
61    /// # Returns
62    /// A temporary-file envelope for facade validation.
63    #[inline]
64    #[must_use]
65    pub fn new(info: OpenedFileInfo, session: Box<dyn TempResourceSpi>) -> Self {
66        Self { info, session }
67    }
68
69    /// Returns the provider-owned parts to the facade.
70    ///
71    /// # Returns
72    /// The claimed identity and provider lifecycle session.
73    #[inline]
74    #[must_use]
75    pub(crate) fn into_parts(self) -> (OpenedFileInfo, Box<dyn TempResourceSpi>) {
76        (self.info, self.session)
77    }
78}
qubit_fs/spi/opened_temp_file.rs

qubit_fs/spi/
opened_temp_file.rs
