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.
// =============================================================================
//! Provider-side asynchronous directory enumeration sessions.

use super::SpiFuture;
use crate::error::FsResult;
use crate::metadata::DirEntry;

/// Provider session underlying a concrete
/// [`crate::directory::AsyncDirectoryStream`].
///
/// # Examples
///
/// ```
/// use qubit_fs::spi::AsyncDirectoryStreamSession;
///
/// fn accepts_session<T: AsyncDirectoryStreamSession>() {}
/// ```
pub trait AsyncDirectoryStreamSession: Send {
    /// Asynchronously reads the next directory entry or provider page.
    ///
    /// # Returns
    /// A future resolving to one entry or `None` at end of enumeration.
    fn next_entry_async(&mut self) -> SpiFuture<'_, FsResult<Option<DirEntry>>>;
}