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

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

use crate::path::Path;
use crate::temp::PersistOptions;

/// A facade-created request to persist a temporary resource.
///
/// # Examples
///
/// ```rust
/// use qubit_fs::path::Path;
/// use qubit_fs::spi::PersistRequest;
/// use qubit_fs::temp::PersistOptions;
///
/// let target = Path::parse("/final")?;
/// assert!(std::any::type_name::<PersistRequest<'_>>().contains("PersistRequest"));
/// assert_eq!("/final", target.as_str());
/// let _ = PersistOptions::default();
/// # Ok::<(), qubit_fs::FsError>(())
/// ```
pub struct PersistRequest<'a> {
    /// Validated persistence destination.
    target: &'a Path,
    /// Validated persistence requirements.
    options: PersistOptions,
}

impl<'a> PersistRequest<'a> {
    /// Creates the request within the facade boundary.
    ///
    /// # Parameters
    /// - `target`: Validated persistence destination.
    /// - `options`: Validated persistence requirements.
    ///
    /// # Returns
    /// A provider persistence request borrowing `target`.
    #[inline]
    pub(crate) const fn new(target: &'a Path, options: PersistOptions) -> Self {
        Self { target, options }
    }

    /// Returns the validated destination path.
    ///
    /// # Returns
    /// The validated persistence destination.
    #[inline]
    #[must_use]
    pub const fn target(&self) -> &'a Path {
        self.target
    }

    /// Returns persistence requirements.
    ///
    /// # Returns
    /// The immutable persistence requirements.
    #[inline]
    #[must_use]
    pub const fn options(&self) -> &PersistOptions {
        &self.options
    }
}