qubit-fs 0.3.2

Provider-neutral synchronous and asynchronous filesystem abstraction for Rust
Documentation
// =============================================================================
//    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 that providers can
/// inspect but cannot construct.
///
/// # Examples
///
/// ```rust
/// use qubit_fs::spi::PersistRequest;
///
/// fn inspect_persist_request(request: PersistRequest<'_>) -> (&str, bool) {
///     (request.target().as_str(), request.options().overwrite())
/// }
///
/// // A provider's persist implementation receives this request from the facade.
/// let _ = inspect_persist_request;
/// ```
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`.
    #[must_use]
    #[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
    }
}