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
// =============================================================================
// Copyright (c) 2026 Haixing Hu.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0.
// =============================================================================
// facade.
//! Provider-opened synchronous directory stream envelope.
use super::DirectoryStreamSpi;
/// An already-open provider directory stream.
///
/// # Examples
///
/// ```rust
/// use qubit_fs::error::FsResult;
/// use qubit_fs::metadata::DirEntry;
/// use qubit_fs::spi::{DirectoryStreamSpi, OpenedDirectoryStream};
///
/// struct EmptyStream;
/// impl DirectoryStreamSpi for EmptyStream {
/// fn next_entry(&mut self) -> FsResult<Option<DirEntry>> {
/// Ok(None)
/// }
/// }
/// let _stream = OpenedDirectoryStream::new(Box::new(EmptyStream));
/// ```
pub struct OpenedDirectoryStream {
/// Provider enumeration session awaiting facade validation.
stream: Box<dyn DirectoryStreamSpi>,
}
impl OpenedDirectoryStream {
/// Wraps a directory stream which the provider has fully opened.
///
/// # Parameters
/// - `stream`: Provider enumeration session.
///
/// # Returns
/// An opened-directory-stream envelope for the facade.
#[inline]
#[must_use]
pub fn new(stream: Box<dyn DirectoryStreamSpi>) -> Self {
Self { stream }
}
/// Returns the opened stream to the facade.
///
/// # Returns
/// The provider enumeration session.
#[inline]
#[must_use]
pub(crate) fn into_stream(self) -> Box<dyn DirectoryStreamSpi> {
self.stream
}
}