Struct nix::dir::Dir

pub struct Dir(_);

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

impl Dir

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

Opens the given path as with fcntl::open.

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

Opens the given path as with fcntl::openat.

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

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

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

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

pub fn iter(&mut self) -> Iter<'_>

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

Trait Implementations

impl AsRawFd for Dir

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for Dir

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

Formats the value using the given formatter.

impl Drop for Dir

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Dir

impl Hash for Dir

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl IntoIterator for Dir

type Item = Result<Entry>

The type of the elements being iterated over.

type IntoIter = OwningIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

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())
}

impl PartialEq<Dir> for Dir

fn eq(&self, other: &Dir) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Dir) -> bool

This method tests for !=.

impl Send for Dir

impl StructuralEq for Dir

impl StructuralPartialEq for Dir