---

lat::File Class Reference

Basic file-related functions. More...

#include <Iguana/Utilities/classlib/iobase/File.h>

Inheritance diagram for lat::File:

List of all members.

Public Member Functions
virtual void	abort (void)
virtual void	attach (IOFD fd)
virtual void	close (void)
virtual void	create (const std::string &name, bool exclusive=false, FileAcl perms=0666)
virtual void	create (const char *name, bool exclusive=false, FileAcl perms=0666)
	File (const std::string &name, int flags=IOFlags::OpenRead, FileAcl perms=0666)
	File (const char *name, int flags=IOFlags::OpenRead, FileAcl perms=0666)
	File (IOFD fd, bool autoclose=true)
	File (void)
virtual void	flush (void)
virtual void	open (const std::string &name, int flags=IOFlags::OpenRead, FileAcl perms=0666)
virtual void	open (const char *name, int flags=IOFlags::OpenRead, FileAcl perms=0666)
virtual IOOffset	position (IOOffset offset, Relative whence=SET)
virtual IOSize	read (void *into, IOSize n, IOOffset pos)
virtual IOSize	read (void *into, IOSize n)
virtual IOSize	readv (IOBuffer *into, IOSize length)
virtual void	resize (IOOffset size)
virtual void	setAutoClose (bool closeit)
virtual IOOffset	size (void) const
virtual bool	status (IOStatus &s) const
virtual void	times (Time *ctime, Time *mtime, Time *atime) const
virtual IOSize	write (const void *from, IOSize n, IOOffset pos)
virtual IOSize	write (const void *from, IOSize n)
virtual IOSize	writev (const IOBuffer *from, IOSize length)
	~File (void)
Private Types
enum	{ InternalAutoClose = 4096 }
Private Member Functions
File *	duplicate (File *child) const
File *	duplicate (bool copy) const
	File (IOFD fd, unsigned flags)
Static Private Member Functions
static bool	sysclose (IOFD fd, int *error=0)
static IOFD	sysduplicate (IOFD fd)
static void	sysopen (const char *name, int flags, FileAcl perms, IOFD &newfd, unsigned &newflags)
Private Attributes
unsigned	m_flags

---

Detailed Description

Basic file-related functions.

Most operations related to file names or file system can be found in Filename.

Definition at line 32 of file File.h.

---

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

InternalAutoClose

Definition at line 101 of file File.h.

{ InternalAutoClose = 4096 }; //< Close on delete

---

Constructor & Destructor Documentation

lat::File::File

(

void

)

lat::File::File	(	IOFD	fd,
		bool	autoclose = true
	)

lat::File::File	(	const char *	name,
		int	flags = IOFlags::OpenRead,
		FileAcl	perms = 0666
	)

lat::File::File	(	const std::string &	name,
		int	flags = IOFlags::OpenRead,
		FileAcl	perms = 0666
	)

lat::File::~File

(

void

)

lat::File::File	(	IOFD	fd,
		unsigned	flags
	)			[private]

---

Member Function Documentation

virtual void lat::File::abort

(

void

)

[virtual]

virtual void lat::File::attach

(

IOFD

fd

)

[virtual]

virtual void lat::File::close

(

void

)

[virtual]

Reimplemented from lat::IOChannel.

Referenced by IgConfigElement::initConfiguration().

virtual void lat::File::create	(	const std::string &	name,
		bool	exclusive = false,
		FileAcl	perms = 0666
	)			[virtual]

virtual void lat::File::create	(	const char *	name,
		bool	exclusive = false,
		FileAcl	perms = 0666
	)			[virtual]

File* lat::File::duplicate

(

File *

child

)

const [private]

File* lat::File::duplicate

(

bool

copy

)

const [private]

virtual void lat::File::flush

(

void

)

[virtual]

Reimplemented from lat::Storage.

virtual void lat::File::open	(	const std::string &	name,
		int	flags = IOFlags::OpenRead,
		FileAcl	perms = 0666
	)			[virtual]

virtual void lat::File::open	(	const char *	name,
		int	flags = IOFlags::OpenRead,
		FileAcl	perms = 0666
	)			[virtual]

Referenced by IgConfigElement::initConfiguration().

virtual IOOffset lat::File::position	(	IOOffset	offset,
		Relative	whence = SET
	)			[virtual]

Implements lat::Storage.

virtual IOSize lat::File::read	(	void *	into,
		IOSize	n,
		IOOffset	pos
	)			[virtual]

Reimplemented from lat::Storage.

virtual IOSize lat::File::read	(	void *	into,
		IOSize	n
	)			[virtual]

Reimplemented from lat::IOChannel.

virtual IOSize lat::File::readv	(	IOBuffer *	into,
		IOSize	length
	)			[virtual]

Reimplemented from lat::IOChannel.

virtual void lat::File::resize

(

IOOffset

size

)

[virtual]

Implements lat::Storage.

virtual void lat::File::setAutoClose

(

bool

closeit

)

[virtual]

virtual IOOffset lat::File::size

(

void

)

const [virtual]

Reimplemented from lat::Storage.

virtual bool lat::File::status

(

IOStatus &

s

)

const [virtual]

static bool lat::File::sysclose	(	IOFD	fd,
		int *	error = 0
	)			[static, private]

Reimplemented from lat::IOChannel.

static IOFD lat::File::sysduplicate

(

IOFD

fd

)

[static, private]

static void lat::File::sysopen	(	const char *	name,
		int	flags,
		FileAcl	perms,
		IOFD &	newfd,
		unsigned &	newflags
	)			[static, private]

virtual void lat::File::times	(	Time *	ctime,
		Time *	mtime,
		Time *	atime
	)			const [virtual]

virtual IOSize lat::File::write	(	const void *	from,
		IOSize	n,
		IOOffset	pos
	)			[virtual]

Reimplemented from lat::Storage.

virtual IOSize lat::File::write	(	const void *	from,
		IOSize	n
	)			[virtual]

Reimplemented from lat::IOChannel.

virtual IOSize lat::File::writev	(	const IOBuffer *	from,
		IOSize	length
	)			[virtual]

Reimplemented from lat::IOChannel.

---

Member Data Documentation

unsigned lat::File::m_flags [private]

Definition at line 112 of file File.h.

---

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

• Iguana/Utilities/classlib/iobase/File.h

---