Struct nix::dir::Dir[−][src]

pub struct Dir(_);

Expand description

An open directory.

This is a lower-level interface than std::fs::ReadDir. Notable differences:

can be opened from a file descriptor (as returned by openat, perhaps before knowing if the path represents a file or directory).
implements AsRawFd, so it can be passed to fstat, openat, etc. The file descriptor continues to be owned by the Dir, so callers must not keep a RawFd after the Dir is dropped.
can be iterated through multiple times without closing and reopening the file descriptor. Each iteration rewinds when finished.
returns entries for . (current directory) and .. (parent directory).
returns entries’ names as a CStr (no allocation or conversion beyond whatever libc does).

Implementations

[src]

impl Dir

[src]

pub fn open<P: ?Sized + NixPath>(
 path: &P,
 oflag: OFlag,
 mode: Mode
) -> Result<Self>

Opens the given path as with fcntl::open.

[src]

pub fn openat<P: ?Sized + NixPath>(
 dirfd: RawFd,
 path: &P,
 oflag: OFlag,
 mode: Mode
) -> Result<Self>

Opens the given path as with fcntl::openat.

[src]

pub fn from<F: IntoRawFd>(fd: F) -> Result<Self>

Converts from a descriptor-based object, closing the descriptor on success or failure.

[src]

pub fn from_fd(fd: RawFd) -> Result<Self>

Converts from a file descriptor, closing it on success or failure.

[src]

pub fn iter(&mut self) -> Iter<'_>ⓘ
Notable traits for Iter<'d>
`impl<'d> Iterator for Iter<'d> type Item = Result<Entry>;`

Returns an iterator of Result<Entry> which rewinds when finished.

Trait Implementations

[src]

impl AsRawFd for Dir

[src]

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

[src]

impl Debug for Dir

[src]

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

[src]

impl Drop for Dir

[src]

fn drop(&mut self)

Executes the destructor for this type. Read more

[src]

impl Hash for Dir

[src]

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

[src]

Creates a owning iterator, that is, one that takes ownership of the Dir. The Dir cannot be used after calling this. This can be useful when you have a function that both creates a Dir instance and returns an Iterator.

Example:

use nix::{dir::Dir, fcntl::OFlag, sys::stat::Mode};
use std::{iter::Iterator, string::String};

fn ls_upper(dirname: &str) -> impl Iterator<Item=String> {
    let d = Dir::open(dirname, OFlag::O_DIRECTORY, Mode::S_IXUSR).unwrap();
    d.into_iter().map(|x| x.unwrap().file_name().as_ref().to_string_lossy().to_ascii_uppercase())
}