qubit-fs 0.2.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.
//! Provider-opened synchronous reader envelope.

use qubit_io::Input;

use crate::metadata::OpenedFileInfo;

/// An already-open provider reader.
///
/// # Examples
///
/// ```rust
/// use qubit_fs::metadata::{FileKind, FileMetadata, FileSystemId, OpenedFileInfo};
/// use qubit_fs::path::Path;
/// use qubit_fs::spi::OpenedReader;
/// use std::io::Cursor;
///
/// let info = OpenedFileInfo::new(FileSystemId::new("doc")?, Path::parse("/report")?)
///     .with_metadata(FileMetadata::new(FileKind::File));
/// let _reader = OpenedReader::new(info, Box::new(Cursor::new(b"report".to_vec())));
/// # Ok::<(), qubit_fs::FsError>(())
/// ```
pub struct OpenedReader {
    /// Resource identity claimed by the provider.
    info: OpenedFileInfo,
    /// Provider byte-input session.
    reader: Box<dyn Input<Item = u8> + Send>,
}

impl OpenedReader {
    /// Wraps a reader which the provider has fully opened.
    ///
    /// # Parameters
    /// - `info`: Identity and metadata claimed for the opened resource.
    /// - `reader`: Provider reader session.
    ///
    /// # Returns
    /// An opened-reader envelope for facade validation.
    #[inline]
    #[must_use]
    pub fn new(info: OpenedFileInfo, reader: Box<dyn Input<Item = u8> + Send>) -> Self {
        Self { info, reader }
    }

    /// Returns the opened reader to the facade.
    ///
    /// # Returns
    /// The claimed resource identity and provider reader session.
    #[inline]
    #[must_use]
    pub(crate) fn into_parts(self) -> (OpenedFileInfo, Box<dyn Input<Item = u8> + Send>) {
        (self.info, self.reader)
    }
}