UCommon
Public Member Functions | Static Public Member Functions
ucommon::dir Class Reference

Convenience class for directories. More...

#include <fsys.h>

Inheritance diagram for ucommon::dir:
Inheritance graph
[legend]
Collaboration diagram for ucommon::dir:
Collaboration graph
[legend]

Public Member Functions

void close (void)
 Close and release directory object.
 
 dir (const char *path)
 Construct and open a directory path. More...
 
 dir ()
 Construct an unopened directory.
 
int err (void) const
 
void open (const char *path)
 Open a directory path for reading. More...
 
 operator bool () const
 Test if file descriptor is open. More...
 
bool operator! () const
 Test if file descriptor is closed. More...
 
ssize_t read (char *buffer, size_t count)
 Read data from directory. More...
 
void reset (void)
 
 ~dir ()
 Close and release directory.
 

Static Public Member Functions

static int create (const char *path, unsigned mode)
 Simple direct method to create a directory. More...
 
static int remove (const char *path)
 Remove an empty directory. More...
 

Detailed Description

Convenience class for directories.

Author
David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 743 of file fsys.h.

Constructor & Destructor Documentation

◆ dir()

ucommon::dir::dir ( const char *  path)

Construct and open a directory path.

Parameters
pathof directory.

Member Function Documentation

◆ create()

static int ucommon::dir::create ( const char *  path,
unsigned  mode 
)
static

Simple direct method to create a directory.

Parameters
pathof directory to create.
modeof directory.
Returns
error number or 0 on success.

◆ open()

void ucommon::dir::open ( const char *  path)

Open a directory path for reading.

Parameters
pathto open.

◆ operator bool()

ucommon::dir::operator bool ( ) const
inline

Test if file descriptor is open.

Returns
true if open.

Definition at line 816 of file fsys.h.

◆ operator!()

bool ucommon::dir::operator! ( ) const
inline

Test if file descriptor is closed.

Returns
true if closed.

Definition at line 824 of file fsys.h.

◆ read()

ssize_t ucommon::dir::read ( char *  buffer,
size_t  count 
)

Read data from directory.

Parameters
bufferto read into.
countof bytes to read.
Returns
bytes transferred, -1 if error.

◆ remove()

static int ucommon::dir::remove ( const char *  path)
static

Remove an empty directory.

Parameters
pathof directory.
Returns
error number or 0 on success.

The documentation for this class was generated from the following file: