[−][src]Struct tokio::fs::ReadDir
fs
only.Stream of the entries in a directory.
This stream is returned from the read_dir
function of this module and
will yield instances of DirEntry
. Through a DirEntry
information like the entry's path and possibly other metadata can be
learned.
Errors
This stream will return an Err
if there's some sort of intermittent
IO error during iteration.
Implementations
impl ReadDir
[src]
pub async fn next_entry(&mut self) -> Result<Option<DirEntry>>
[src]
Returns the next entry in the directory stream.
pub fn poll_next_entry(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Option<DirEntry>>>
[src]
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Option<DirEntry>>>
Polls for the next directory entry in the stream.
This method returns:
Poll::Pending
if the next directory entry is not yet available.Poll::Ready(Ok(Some(entry)))
if the next directory entry is available.Poll::Ready(Ok(None))
if there are no more directory entries in this stream.Poll::Ready(Err(err))
if an IO error occurred while reading the next directory entry.
When the method returns Poll::Pending
, the Waker
in the provided
Context
is scheduled to receive a wakeup when the next directory entry
becomes available on the underlying IO resource.
Note that on multiple calls to poll_next_entry
, only the Waker
from
the Context
passed to the most recent call is scheduled to receive a
wakeup.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for ReadDir
[src]
impl Send for ReadDir
[src]
impl Sync for ReadDir
[src]
impl Unpin for ReadDir
[src]
impl !UnwindSafe for ReadDir
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut Tⓘ
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,