ucommon
Public Member Functions | Static Public Member Functions
ost::Dir Class Reference

A low level portable directory class. More...

#include <file.h>

Inherits ost::File.

Public Member Functions

void close (void)
 
 Dir (const char *name=((void *) 0))
 
const char * getName (void)
 
bool isValid (void)
 
void open (const char *name)
 
bool operator! ()
 
const char * operator* ()
 
const char * operator++ ()
 
const char * operator++ (int)
 
bool rewind (void)
 

Static Public Member Functions

static bool create (const char *path, Attr attr=attrGroup)
 
static bool getPrefix (char *path, size_t size=4096)
 
static bool remove (const char *path)
 
static bool setPrefix (const char *path)
 
- Static Public Member Functions inherited from ost::File
static char * getDirname (const char *path, char *buffer, size_t size=4096)
 
static const char * getExtension (const char *path)
 
static const char * getFilename (const char *path)
 
static char * getFilename (const char *path, char *buffer, size_t size=255)
 
static char * getRealpath (const char *path, char *buffer, size_t size=4096)
 

Additional Inherited Members

- Public Types inherited from ost::File
enum  Access { accessReadOnly = 00, accessWriteOnly = 01, accessReadWrite = 02 }
 
typedef enum Access Access
 
enum  Attr { attrInvalid = 0, attrPrivate = 0400 | 0200, attrGroup = attrPrivate | ( 0400 >> 3) | ( 0200 >> 3), attrPublic = attrGroup | ( ( 0400 >> 3) >> 3) | ( ( 0200 >> 3) >> 3) }
 
typedef enum Attr Attr
 
enum  Complete { completionImmediate, completionDelayed, completionDeferred }
 
typedef enum Complete Complete
 
enum  Error {
  errSuccess = 0, errNotOpened, errMapFailed, errInitFailed,
  errOpenDenied, errOpenFailed, errOpenInUse, errReadInterrupted,
  errReadIncomplete, errReadFailure, errWriteInterrupted, errWriteIncomplete,
  errWriteFailure, errLockFailure, errExtended
}
 
typedef enum Error Error
 
enum  Mapping { mappedRead = accessReadOnly, mappedWrite = accessWriteOnly, mappedReadWrite = accessReadWrite }
 
typedef enum Mapping Mapping
 
enum  Open {
  openReadOnly = 00, openWriteOnly = 01, openReadWrite = 02, openAppend = 01 | 02000,
  openSync = 02 | 04010000, openTruncate = 02 | 01000
}
 
typedef enum Open Open
 
- Protected Types inherited from ost::File
typedef struct ost::File::_fcb fcb_t
 

Detailed Description

A low level portable directory class.

Used to support ccstd Directory container. This provides a basic mechanism for allocating and accessing file entries.

Author
David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m low level directory access class.

Definition at line 240 of file file.h.


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