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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
// facade.
//! Validated temporary-file creation request.

use crate::temp::TempOptions;

/// A facade-created temporary-file request.
///
/// # Examples
///
/// ```rust
/// use qubit_fs::spi::CreateTempFileRequest;
/// use qubit_fs::temp::TempOptions;
///
/// assert!(std::any::type_name::<CreateTempFileRequest>().contains("CreateTempFileRequest"));
/// assert_eq!(TempOptions::default(), TempOptions::new());
/// ```
pub struct CreateTempFileRequest {
    /// Validated temporary-file creation options.
    options: TempOptions,
}

impl CreateTempFileRequest {
    /// Creates this request inside the facade boundary.
    ///
    /// # Parameters
    /// - `options`: Validated temporary-file creation options.
    ///
    /// # Returns
    /// A provider temporary-file request.
    #[allow(dead_code)]
    #[inline]
    pub(crate) const fn new(options: TempOptions) -> Self {
        Self { options }
    }

    /// Returns requested temporary-file options.
    ///
    /// # Returns
    /// The immutable temporary-file creation options.
    #[inline]
    #[must_use]
    pub const fn options(&self) -> &TempOptions {
        &self.options
    }
}